Release 2.12.2

Also reorder some methods to fix errors

.bandit-test.yml

@@ -0,0 +1 @@
+skips: ['B101', 'B104', 'B105', 'B106', 'B404']

.bandit.yml

@@ -0,0 +1 @@
+skips: ['B404', 'B603']

.dockerignore

@@ -0,0 +1,14 @@
+.eggs/
+.git/
+.github/
+.idea/
+.mypy_cache/
+.pytest_cache/
+.tox/
+.venv/
+
+*.egg-info/
+__pycache__/
+*.pyc
+*.pyd
+*.pyo

.github/ISSUE_TEMPLATE/01-bug-report.md

@@ -0,0 +1,28 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+## Summary
+
+A clear and concise description of what the bug is.
+
+### Steps to reproduce
+
+Steps to reproduce the behavior (commands, environment etc).
+
+### Expected behavior
+
+A clear and concise description of what you expected to happen.
+
+### Logs
+
+Add logs to help explain your problem. By default, the application writes logs into `/dev/log` which is usually default systemd journal and can be accessed by `journalctl` command.
+
+You can also attach any additional information which can be helpful, e.g. configuration used by the application (be aware of passwords and other secrets if any); it can be generated by using `ahriman config` command.
+
+It is also sometimes useful to have information about installed packages which can be accessed by `ahriman version` command.

.github/ISSUE_TEMPLATE/02-security-report.md

@@ -0,0 +1,20 @@
+---
+name: Security report
+about: Create a report related to security issues
+title: ''
+labels: security
+assignees: ''
+
+---
+
+## Summary
+
+A clear and concise description of what the issue is.
+
+### Steps to reproduce
+
+Steps to reproduce the behavior (commands, environment etc).
+
+### Intended impact
+
+Brief optional description of how this vulnerability can be used and which effects can be achieved. 

.github/ISSUE_TEMPLATE/03-feature-request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+## Feature summary
+
+Brief description of the feature required
+
+### Cause of the feature request
+
+A clear and concise description of what the problem is. E.g. I'm always frustrated when [...]
+
+### Proposed changes and/or features
+
+A clear and concise description of what you want to happen.

.github/ISSUE_TEMPLATE/04-discussion.md

@@ -0,0 +1,12 @@
+---
+name: Question
+about: Create an issue to get help with project
+title: ''
+labels: question
+assignees: ''
+
+---
+
+## Describe your question below
+
+A clear and concise description of your issue for which you would like to get help.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,13 @@
+## Summary
+
+Brief description of the pull request. Try to provide clear explanation for major changes.
+
+Please make sure that branch called either `feature/feature-name` for feature-related pull requests or `bug/bug-name` for bug-related ones.
+
+Put `closes #ISSUE` in case if the pull requests solves one of the opened issues.
+
+### Checklist
+
+- [ ] Tests to cover new code
+- [ ] `make check` passed
+- [ ] `make tests` passed

.github/workflows/docker.yml

@@ -0,0 +1,51 @@
+name: Docker image
+
+on:
+  push:
+    branches: [ master ]
+    tags:
+      - '*'
+      - '!*rc*'
+
+jobs:
+  docker-image:
+
+    runs-on: ubuntu-latest
+
+    permissions:
+      packages: write
+
+    steps:
+      - uses: docker/setup-qemu-action@v2
+
+      - uses: docker/setup-buildx-action@v2
+
+      - name: Login to docker hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Login to github container registry
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract docker metadata
+        id: meta
+        uses: docker/metadata-action@v3
+        with:
+          images: |
+            arcan1s/ahriman
+            ghcr.io/arcan1s/ahriman
+          tags: |
+            type=semver,pattern={{raw}}
+            type=edge
+
+      - name: Build an image and push
+        uses: docker/build-push-action@v4
+        with:
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}

.github/workflows/release.yml

@@ -0,0 +1,41 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - '*'
+
+jobs:
+  make-release:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Extract version
+        id: version
+        run: echo ::set-output name=VERSION::${GITHUB_REF#refs/tags/}
+
+      - name: Create changelog
+        id: changelog
+        uses: jaywcjlove/changelog-generator@main
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          filter: 'Release \d+\.\d+\.\d+'
+
+      - name: Create archive
+        run: make archive
+        env:
+          VERSION: ${{ steps.version.outputs.VERSION }}
+
+      - name: Publish release
+        uses: softprops/action-gh-release@v1
+        with:
+          body: |
+            ${{ steps.changelog.outputs.compareurl }}
+            ${{ steps.changelog.outputs.changelog }}
+          files: ahriman-*-src.tar.xz
+          fail_on_unmatched_files: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/setup.sh

@@ -0,0 +1,59 @@
+#!/bin/bash
+# Install the package and run main install commands
+
+set -ex
+
+[[ $1 = "minimal" ]] && MINIMAL_INSTALL=1
+
+# install dependencies
+echo -e '[arcanisrepo]\nServer = http://repo.arcanis.me/$arch\nSigLevel = Never' | tee -a /etc/pacman.conf
+# refresh the image
+pacman --noconfirm -Syu
+# main dependencies
+pacman --noconfirm -Sy base-devel devtools git pyalpm python-cerberus python-inflection python-passlib python-requests python-srcinfo python-systemd sudo
+# make dependencies
+pacman --noconfirm -Sy python-build python-flit python-installer python-wheel
+# optional dependencies
+if [[ -z $MINIMAL_INSTALL ]]; then
+    # VCS support
+    pacman --noconfirm -Sy breezy darcs mercurial subversion
+    # web server
+    pacman --noconfirm -Sy python-aioauth-client python-aiohttp python-aiohttp-apispec-git python-aiohttp-cors python-aiohttp-debugtoolbar python-aiohttp-jinja2 python-aiohttp-security python-aiohttp-session python-cryptography python-jinja
+    # additional features
+    pacman --noconfirm -Sy gnupg python-boto3 rsync
+fi
+# FIXME since 1.0.4 devtools requires dbus to be run, which doesn't work now in container
+cp "docker/systemd-nspawn.sh" "/usr/local/bin/systemd-nspawn"
+
+# create fresh tarball
+make VERSION=1.0.0 archlinux  # well, it does not really matter which version we will put here
+# run makepkg
+mv ahriman-*-src.tar.xz package/archlinux
+chmod +777 package/archlinux  # because fuck you that's why
+cd package/archlinux
+sudo -u nobody -- makepkg -cf --skipchecksums --noconfirm
+pacman --noconfirm -U ahriman-1.0.0-1-any.pkg.tar.zst
+# create machine-id which is required by build tools
+systemd-machine-id-setup
+
+# initial setup command as root
+[[ -z $MINIMAL_INSTALL ]] && WEB_ARGS=("--web-port" "8080")
+ahriman -a x86_64 -r "github" service-setup --packager "ahriman bot <ahriman@example.com>" "${WEB_ARGS[@]}"
+# validate configuration
+ahriman service-config-validate --exit-code
+# enable services
+systemctl enable ahriman-web
+systemctl enable ahriman@x86_64-github.timer
+if [[ -z $MINIMAL_INSTALL ]]; then
+    # run web service (detached)
+    sudo -u ahriman -- ahriman web &
+    WEB_PID=$!
+fi
+# add the first package
+sudo -u ahriman -- ahriman package-add --now ahriman
+# check if package was actually installed
+test -n "$(find "/var/lib/ahriman/repository/github/x86_64" -name "ahriman*pkg*")"
+# run package check
+sudo -u ahriman -- ahriman repo-update
+# stop web service lol
+[[ -z $WEB_PID ]] || kill $WEB_PID

.github/workflows/setup.yml

@@ -0,0 +1,40 @@
+name: Setup
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  run-setup-minimal:
+
+    runs-on: ubuntu-latest
+
+    container:
+      image: archlinux:base
+      volumes:
+        - ${{ github.workspace }}:/build
+      options: --privileged -w /build
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup the minimal service in arch linux container
+        run: .github/workflows/setup.sh minimal
+
+  run-setup:
+
+    runs-on: ubuntu-latest
+
+    container:
+      image: archlinux:base
+      volumes:
+        - ${{ github.workspace }}:/build
+      options: --privileged -w /build
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup the service in arch linux container
+        run: .github/workflows/setup.sh

.github/workflows/tests.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+# Install dependencies and run test in container
+
+set -ex
+
+# install dependencies
+pacman --noconfirm -Syu base-devel python-setuptools python-tox
+
+# run test and check targets
+make check tests

.github/workflows/tests.yml

@@ -0,0 +1,24 @@
+name: Tests
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  run-tests:
+
+    runs-on: ubuntu-latest
+
+    container:
+      image: archlinux:base
+      volumes:
+        - ${{ github.workspace }}:/build
+      options: -w /build
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Run check and tests in arch linux container
+        run: .github/workflows/tests.sh

.gitignore

@@ -94,3 +94,8 @@ ENV/
 .venv/
 
 *.tar.xz
+status_cache.json
+
+*.db
+
+docs/html/

.readthedocs.yaml

@@ -0,0 +1,23 @@
+version: 2
+
+formats:
+  - pdf
+
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+  fail_on_warning: true
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+        - s3
+        - web

AUTHORS

@@ -0,0 +1,2 @@
+Current maintainer:
+Evgenii Alekseev <esalexeev (at) gmail (dot) com>

CONFIGURING.md

@@ -1,85 +0,0 @@
-# ahriman configuration
-
-Some groups can be specified for each architecture separately. E.g. if there are `build` and `build_x86_64` groups it will use the `build_x86_64` for the `x86_64` architecture and `build` for any other (architecture specific group has higher priority).
-
-## `settings` group
-
-Base configuration settings.
-
-* `include` - path to directory with configuration files overrides, string, required.
-* `logging` - path to logging configuration, string, required. Check `logging.ini` for reference.
-
-## `alpm` group
-
-libalpm and AUR related configuration.
-
-* `aur_url` - base url for AUR, string, required.
-* `database` - path to pacman local database cache, string, required.
-* `repositories` - list of pacman repositories, space separated list of strings, required.
-* `root` - root for alpm library, string, required.
-
-## `build_*` groups
-
-Build related configuration. Group name must refer to architecture, e.g. it should be `build_x86_64` for x86_64 architecture.
-
-* `archbuild_flags` - additional flags passed to `archbuild` command, space separated list of strings, optional.
-* `build_command` - default build command, string, required.
-* `ignore_packages` - list packages to ignore during a regular update (manual update will still work), space separated list of strings, optional.
-* `makepkg_flags` - additional flags passed to `makepkg` command, space separated list of strings, optional.
-* `makechrootpkg_flags` - additional flags passed to `makechrootpkg` command, space separated list of strings, optional.
-
-## `repository` group
-
-Base repository settings.
-
-* `name` - repository name, string, required.
-* `root` - root path for application, string, required.
-
-## `sign_*` groups
-
-Settings for signing packages or repository. Group name must refer to architecture, e.g. it should be `sign_x86_64` for x86_64 architecture.
-
-* `target` - configuration flag to enable signing, space separated list of strings, required. Allowed values are `package` (sign each package separately), `repository` (sign repository database file).
-* `key` - default PGP key, string, required. This key will also be used for database signing if enabled.
-* `key_*` settings - PGP key which will be used for specific packages, string, optional. For example, if there is `key_yay` option the specified key will be used for yay package and default key for others.
-
-## `report` group
-
-Report generation settings.
-
-* `target` - list of reports to be generated, space separated list of strings, optional. Allowed values are `html`.
-
-### `html_*` groups
-
-Group name must refer to architecture, e.g. it should be `html_x86_64` for x86_64 architecture.
-
-* `path` - path to html report file, string, required.
-* `homepage` - link to homepage, string, optional.
-* `link_path` - prefix for HTML links, string, required.
-* `template_path` - path to Jinja2 template, string, required.
-
-## `upload` group
-
-Remote synchronization settings.
-
-* `target` - list of synchronizations to be used, space separated list of strings, optional. Allowed values are `rsync`, `s3`.
-
-### `rsync_*` groups
-
-Group name must refer to architecture, e.g. it should be `rsync_x86_64` for x86_64 architecture. Requires `rsync` package to be installed. Do not forget to configure ssh for user `ahriman`.
-
-* `remote` - remote server to rsync (e.g. `1.2.3.4:5678:path/to/sync`), string, required.
-
-### `s3_*` groups
-
-Group name must refer to architecture, e.g. it should be `s3_x86_64` for x86_64 architecture. Requires `aws-cli` package to be installed. Do not forget to configure it for user `ahriman`.
-
-* `bucket` - bucket name (e.g. `s3://bucket/path`), string, required.
-
-## `web_*` groups
-
-Web server settings. If any of `host`/`port` is not set, web integration will be disabled. Group name must refer to architecture, e.g. it should be `web_x86_64` for x86_64 architecture.
-
-* `host` - host to bind, string, optional.
-* `port` - port to bind, int, optional.
-* `templates` - path to templates directory, string, required.

CONTRIBUTING.md

@@ -0,0 +1,249 @@
+# Contributing to ahriman
+
+Welcome to ahriman! The goal of the project is to provide the best user experience to manage Arch linux repositories. In order to follow this we set some limitations for the issue creations and heavily restricted code contribution.
+
+## Create an issue
+
+Basically just follow the suggested templates:
+
+* Bug report requires at least the way to reproduce the issue and behaviour description (expected and actual ones). In order to resolve the bug, the additional questions may be asked, please consider them as lesser evil.
+* Feature requests basically just require feature description and the purpose why do you want this feature to be implemented. It is required to make sure that the feature you want is going to be implemented in the way you really want it (and to make sure that this feature is not already implemented).
+* Questions and discussions have free templates, and you are free to ask your question in the way you want.
+
+## Code contribution
+
+There are some strict limitation for suggested pull requests:
+
+* `autopep8`, `bandit`, `pylint`, `mypy` must pass.
+* Test coverage must remain 100%.
+
+### Code formatting
+
+In order to resolve all difficult cases the `autopep8` is used. You can perform formatting at any time by running `make check` or running `autopep8` command directly.
+
+### Code style
+
+Again, the most checks can be performed by `make check` command, though some additional guidelines must be applied:
+
+* Every class, every function (including private and protected), every attribute must be documented. The project follows [Google style documentation](https://google.github.io/styleguide/pyguide.html). The only exception is local functions.
+* Correct way to document function (if a section is empty, e.g. no notes or there are no args, it should be omitted) is the following:
+
+    ```python
+    def foo(argument: str, *, flag: bool = False) -> int:
+        """
+        do foo. With very very very long
+        docstring
+  
+        Notes:
+            Very important note about this function
+  
+        Args:
+            argument(str): an argument. This argument has
+                long description also
+            flag(bool, optional): a flag (Default value = False)
+  
+        Returns:
+            int: result with
+                long description
+  
+        Raises:
+            RuntimeError: a local function error occurs
+  
+        Examples:
+            Very informative example how to use this function, e.g.::
+  
+                >>> foo("argument", flag=False)
+  
+            Note that function documentation is in rST.
+        """
+    ```
+  
+  `Returns` should be replaced with `Yields` for generators.
+
+  Class attributes should be documented in the following way:
+
+    ```python
+    class Clazz(BaseClazz):
+        """
+        brand-new implementation of :class:`BaseClazz`
+  
+        Attributes:
+            CLAZZ_ATTRIBUTE(int): (class attribute) a brand-new class attribute
+            instance_attribute(str): an instance attribute
+  
+        Examples:
+            Very informative class usage example, e.g.::
+  
+                >>> from module import Clazz
+                >>> clazz = Clazz()
+        """
+  
+        CLAZZ_ATTRIBUTE = 42
+  
+        def __init__(self, *args: Any, **kwargs: Any) -> None:
+            """
+            default constructor
+  
+            Args:
+                *args(Any): positional arguments
+                **kwargs(Any): keyword arguments
+            """
+            self.instance_attribute = ""
+    ```
+
+* Type annotations are the must, even for local functions. For the function argument `self` (for instance methods) and `cls` (for class methods) should not be annotated.
+* For collection types built-in classes must be used if possible (e.g. `dict` instead of `typing.Dict`, `tuple` instead of `typing.Tuple`). In case if built-in type is not available, but `collections.abc` provides interface, it must be used (e.g. `collections.abc.Awaitable` instead of `typing.Awaitable`, `collections.abc.Iterable` instead of `typing.Iterable`). For union classes, the bar operator (`|`) must be used (e.g. `float | int` instead of `typing.Union[float, int]`), which also includes `typinng.Optional` (e.g. `str | None` instead of `Optional[str]`).
+* `classmethod` should (almost) always return `Self`. In case of mypy warning (e.g. if there is a branch in which function doesn't return the instance of `cls`) consider using `staticmethod` instead.
+* Recommended order of function definitions in class:
+
+    ```python
+    class Clazz:
+  
+        def __init__(self) -> None: ...  # replace with `__post_init__` for dataclasses
+
+        @property
+        def property(self) -> Any: ...
+  
+        @cached_property
+        def property_cached(self) -> Any: ...  # cached property has to be treated as normal one
+
+        @classmethod
+        def class_method(cls) -> Self: ...
+
+        @staticmethod
+        def static_method() -> Any: ...
+
+        def __private_method(self) -> Any: ...
+
+        def _protected_method(self) -> Any: ...
+
+        def usual_method(self) -> Any: ...
+
+        def __hash__(self) -> int: ...  # basically any magic (or look-alike) method
+    ```
+  
+  Methods inside one group should be ordered alphabetically, the only exceptions are `__init__` (`__post_init__` for dataclasses), `__new__` and `__del__` methods which should be defined first. For test methods it is recommended to follow the order in which functions are defined.
+
+  Though, we would like to highlight abstract methods (i.e. ones which raise `NotImplementedError`), we still keep in global order at the moment.
+
+  For the most cases there is custom `pylint` plugin, which performs checks automatically.
+
+* Abstract methods must raise `NotImplementedError` instead of using `abc.abstractmethod`. The reason behind this restriction is the fact that we have class/static abstract methods for those we need to define their attribute first making the code harder to read.
+* For any path interactions `pathlib.Path` must be used.
+* Configuration interactions must go through `ahriman.core.configuration.Configuration` class instance.
+* In case if class load requires some actions, it is recommended to create class method which can be used for class instantiating.
+* The code must follow the exception safety, unless it is explicitly asked by end user. It means that most exceptions must be handled and printed to log, no other actions must be done (e.g. raising another exception).
+* Exceptions without parameters should be raised without parentheses, e.g.:
+
+    ```python
+    raise RuntimeError
+    ```
+
+* For the external command `ahriman.core.util.check_output` function must be used.
+* Every temporary file/directory must be removed at the end of processing, no matter what. The `tempfile` module provides good ways to do it.
+* Import order must be the following:
+
+    ```python
+    # optional imports from future module
+    from __future__ import annotations
+
+    # Module import for those which are installed into environment (no matter standard library or not)...
+    import os
+    # ...one per line...
+    import pyalpm
+    # ...in alphabetical order
+    import sys
+
+    # Blank line between
+    # ``from module import submodule`` import
+    from pathlib import Path
+    # ...again in alphabet order. It is possible to do several imports, but make sure that they are also in alphabetical order.
+    from pyalpm import Handle, Package
+
+    # Blank line again and package imports
+    from ahriman.core.configuration import Configuration
+    ```
+
+* One file should define only one class, exception is class satellites in case if file length remains less than 400 lines.
+* It is possible to create file which contains some functions (e.g. `ahriman.core.util`), but in this case you would need to define `__all__` attribute.
+* The file size mentioned above must be applicable in general. In case of big classes consider splitting them into traits. Note, however, that `pylint` includes comments and docstrings into counter, thus you need to check file size by other tools.
+* No global variable is allowed outside of `ahriman` module. `ahriman.core.context` is also special case.
+* Single quotes are not allowed. The reason behind this restriction is the fact that docstrings must be written by using double quotes only, and we would like to make style consistent.
+* If your class writes anything to log, the `ahriman.core.log.LazyLogging` trait must be used.
+* Web API methods must be documented by using `aiohttp_apispec` library. The schema testing mostly should be implemented in related view class tests. Recommended example for documentation (excluding comments):
+
+    ```python
+    import aiohttp_apispec
+
+    from marshmallow import Schema, fields  
+
+    from ahriman.web.schemas import AuthSchema, ErrorSchema, PackageNameSchema, PaginationSchema
+    from ahriman.web.views.base import BaseView
+
+
+    class RequestSchema(Schema):
+
+        field = fields.String(metadata={"description": "Field description", "example": "foo"})
+
+
+    class ResponseSchema(Schema):
+
+        field = fields.String(required=True, metadata={"description": "Field description"})
+
+
+    class Foo(BaseView):
+
+        POST_PERMISSION = ...
+        ROUTES = ...
+
+        @aiohttp_apispec.docs(
+            tags=["Tag"],
+            summary="Do foo",
+            description="Extended description of the method which does foo",
+            responses={
+                200: {"description": "Success response", "schema": ResponseSchema},
+                204: {"description": "Success response"},  # example without json schema response
+                400: {"description": "Bad data is supplied", "schema": ErrorSchema},  # exception raised by this method
+                401: {"description": "Authorization required", "schema": ErrorSchema},  # should be always presented
+                403: {"description": "Access is forbidden", "schema": ErrorSchema},  # should be always presented
+                404: {"description": "Repository is unknown", "schema": ErrorSchema},  # include if BaseView.service() method is called
+                500: {"description": "Internal server error", "schema": ErrorSchema},  # should be always presented
+            },
+            security=[{"token": [POST_PERMISSION]}],
+        )
+        @aiohttp_apispec.cookies_schema(AuthSchema)  # should be always presented
+        @aiohttp_apispec.match_info_schema(PackageNameSchema)
+        @aiohttp_apispec.querystring_schema(PaginationSchema)
+        @aiohttp_apispec.json_schema(RequestSchema(many=True))
+        async def post(self) -> None: ...
+    ```
+
+* It is allowed to change web API to add new fields or remove optional ones. However, in case of model changes, new API version must be introduced.
+* On the other hand, it is allowed to change method signatures, however, it is recommended to add new parameters as optional if possible. Deprecated API can be dropped during major release.
+* Enumerations (`Enum` classes) are allowed and recommended. However, it is recommended to use `StrEnum` class if there are from/to string conversions and `IntEnum` otherwise.
+
+### Other checks
+
+The projects also uses typing checks (provided by `mypy`) and some linter checks provided by `pylint` and `bandit`. Those checks must be passed successfully for any open pull requests.
+
+## Developers how to
+
+### Run automated checks
+
+```shell
+make check tests
+```
+
+### Generate documentation templates
+
+```shell
+make specification
+```
+
+### Create release
+
+```shell
+make VERSION=x.y.z check tests release
+```
+
+The command above will also run checks first and will generate documentation, tags, etc., and will push them to GitHub. Other things will be handled by GitHub workflows automatically.

Dockerfile

@@ -0,0 +1,64 @@
+FROM archlinux:base
+
+# image configuration
+ENV AHRIMAN_ARCHITECTURE="x86_64"
+ENV AHRIMAN_DEBUG=""
+ENV AHRIMAN_FORCE_ROOT=""
+ENV AHRIMAN_HOST="0.0.0.0"
+ENV AHRIMAN_MULTILIB="yes"
+ENV AHRIMAN_OUTPUT=""
+ENV AHRIMAN_PACKAGER="ahriman bot <ahriman@example.com>"
+ENV AHRIMAN_PACMAN_MIRROR=""
+ENV AHRIMAN_PORT=""
+ENV AHRIMAN_POSTSETUP_COMMAND=""
+ENV AHRIMAN_PRESETUP_COMMAND=""
+ENV AHRIMAN_REPOSITORY="aur-clone"
+ENV AHRIMAN_REPOSITORY_SERVER=""
+ENV AHRIMAN_REPOSITORY_ROOT="/var/lib/ahriman/ahriman"
+ENV AHRIMAN_UNIX_SOCKET=""
+ENV AHRIMAN_USER="ahriman"
+ENV AHRIMAN_VALIDATE_CONFIGURATION="yes"
+
+# install environment
+## update pacman.conf with multilib
+RUN echo "[multilib]" >> "/etc/pacman.conf" && \
+    echo "Include = /etc/pacman.d/mirrorlist" >> "/etc/pacman.conf"
+## install minimal required packages
+RUN pacman --noconfirm -Syu binutils fakeroot git make sudo
+## create build user
+RUN useradd -m -d "/home/build" -s "/usr/bin/nologin" build && \
+    echo "build ALL=(ALL) NOPASSWD: ALL" > "/etc/sudoers.d/build"
+COPY "docker/install-aur-package.sh" "/usr/local/bin/install-aur-package"
+## install package dependencies
+## darcs is not installed by reasons, because it requires a lot haskell packages which dramatically increase image size
+RUN pacman -Sy --noconfirm --asdeps devtools git pyalpm python-cerberus python-inflection python-passlib python-requests python-srcinfo && \
+    pacman -Sy --noconfirm --asdeps python-build python-flit python-installer python-wheel && \
+    pacman -Sy --noconfirm --asdeps breezy mercurial python-aiohttp python-aiohttp-cors python-boto3 python-cryptography python-jinja python-requests-unixsocket python-systemd rsync subversion && \
+    runuser -u build -- install-aur-package python-aioauth-client python-aiohttp-apispec-git python-aiohttp-jinja2  \
+                                            python-aiohttp-debugtoolbar python-aiohttp-session python-aiohttp-security
+
+## FIXME since 1.0.4 devtools requires dbus to be run, which doesn't work now in container
+COPY "docker/systemd-nspawn.sh" "/usr/local/bin/systemd-nspawn"
+
+# install ahriman
+## copy tree
+COPY --chown=build . "/home/build/ahriman"
+## create package archive and install it
+RUN cd "/home/build/ahriman" && \
+    make VERSION=$(python -c "from src.ahriman import __version__; print(__version__)") archlinux && \
+    cp ./*-src.tar.xz "package/archlinux" && \
+    cd "package/archlinux" && \
+    runuser -u build -- makepkg --noconfirm --install --skipchecksums && \
+    cd / && rm -r "/home/build/ahriman"
+
+# cleanup unused
+RUN find "/var/cache/pacman/pkg" -type f -delete
+RUN pacman -Qdtq | pacman -Rscn --noconfirm -
+
+VOLUME ["/var/lib/ahriman"]
+
+# minimal runtime ahriman setup
+COPY "docker/entrypoint.sh" "/usr/local/bin/entrypoint"
+ENTRYPOINT ["entrypoint"]
+# default command
+CMD ["repo-update", "--refresh"]

Makefile

@@ -1,9 +1,9 @@
-.PHONY: archive archive_directory archlinux check clean directory push version
+.PHONY: archive archlinux check clean directory html release specification tests version
 .DEFAULT_GOAL := archlinux
 
 PROJECT := ahriman
 
-FILES := COPYING CONFIGURING.md README.md package src setup.py
+FILES := AUTHORS CONTRIBUTING.md COPYING README.md SECURITY.md package pyproject.toml src web.png
 TARGET_FILES := $(addprefix $(PROJECT)/, $(FILES))
 IGNORE_FILES := package/archlinux src/.mypy_cache
 
@@ -16,35 +16,44 @@ archive: archive_directory
 
 archive_directory: $(TARGET_FILES)
 	rm -fr $(addprefix $(PROJECT)/, $(IGNORE_FILES))
-	find $(PROJECT) -type f -name '*.pyc' -delete
+	find "$(PROJECT)" -type f -name "*.pyc" -delete
-	find $(PROJECT) -depth -type d -name '__pycache__' -execdir rm -rf {} +
+	find "$(PROJECT)" -depth -type d -name "__pycache__" -execdir rm -rf {} +
-	find $(PROJECT) -depth -type d -name '*.egg-info' -execdir rm -rf {} +
+	find "$(PROJECT)" -depth -type d -name "*.egg-info" -execdir rm -rf {} +
 
 archlinux: archive
-	sed -i "/sha512sums=('[0-9A-Fa-f]*/s/[^'][^)]*/sha512sums=('$$(sha512sum $(PROJECT)-$(VERSION)-src.tar.xz | awk '{print $$1}')'/" package/archlinux/PKGBUILD
+	sed -i "s/pkgver=.*/pkgver=$(VERSION)/" package/archlinux/PKGBUILD
-	sed -i "s/pkgver=[0-9.]*/pkgver=$(VERSION)/" package/archlinux/PKGBUILD
 
-check:
+check: clean
-	cd src && mypy --implicit-reexport --strict -p $(PROJECT)
+	tox -e check
-	cd src && find $(PROJECT) -name '*.py' -execdir autopep8 --max-line-length 120 -aa -i {} +
-	cd src && pylint --rcfile=../.pylintrc $(PROJECT)
 
 clean:
-	find . -type f -name '$(PROJECT)-*-src.tar.xz' -delete
+	find . -type f -name "$(PROJECT)-*-src.tar.xz" -delete
 	rm -rf "$(PROJECT)"
 
 directory: clean
 	mkdir "$(PROJECT)"
 
-push: archlinux
+html: specification
-	git add package/archlinux/PKGBUILD src/ahriman/version.py
+	rm -rf docs/html
+	tox -e docs-html
+
+release: specification archlinux
+	git add package/archlinux/PKGBUILD src/ahriman/__init__.py docs/ahriman-architecture.svg package/share/man/man1/ahriman.1 package/share/bash-completion/completions/_ahriman package/share/zsh/site-functions/_ahriman
 	git commit -m "Release $(VERSION)"
-	git push
 	git tag "$(VERSION)"
+	git push
 	git push --tags
 
+specification:
+	# make sure that old files are removed
+	find docs -type f -name "$(PROJECT)*.rst" -delete
+	tox -e docs
+
+tests: clean
+	tox -e tests
+
 version:
 ifndef VERSION
 	$(error VERSION is required, but not set)
 endif
-	sed -i "/__version__ = '[0-9.]*/s/[^'][^)]*/__version__ = '$(VERSION)'/" src/ahriman/version.py
+	sed -i 's/^__version__ = .*/__version__ = "$(VERSION)"/' src/ahriman/__init__.py

README.md

@@ -1,68 +1,42 @@
-# ArcHlinux ReposItory MANager
+# ArcH linux ReposItory MANager
+
+[![tests status](https://github.com/arcan1s/ahriman/actions/workflows/tests.yml/badge.svg)](https://github.com/arcan1s/ahriman/actions/workflows/tests.yml)
+[![setup status](https://github.com/arcan1s/ahriman/actions/workflows/setup.yml/badge.svg)](https://github.com/arcan1s/ahriman/actions/workflows/setup.yml)
+[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/arcan1s/ahriman?label=Docker%20image)](https://hub.docker.com/r/arcan1s/ahriman)
+[![CodeFactor](https://www.codefactor.io/repository/github/arcan1s/ahriman/badge)](https://www.codefactor.io/repository/github/arcan1s/ahriman)
+[![Documentation Status](https://readthedocs.org/projects/ahriman/badge/?version=latest)](https://ahriman.readthedocs.io)
 
 Wrapper for managing custom repository inspired by [repo-scripts](https://github.com/arcan1s/repo-scripts).
 
 ## Features
 
-* Install-configure-forget manager for own repository
+* Install-configure-forget manager for the very own repository.
-* Multi-architecture support
+* Multi architecture and repository support.
-* VCS packages support
+* Dependency manager.
-* Sign support with gpg (repository, package, per package settings)
+* VCS packages support.
-* Synchronization to remote services (rsync, s3) and report generation (html)
+* Official repository support.
-* Dependency manager
+* Ability to patch AUR packages and even create package from local PKGBUILDs.
-* Repository status interface
+* Various rebuild options with ability to automatically bump package version.
+* Sign support with gpg (repository, package), multiple packagers support.
+* Triggers for repository updates, e.g. synchronization to remote services (rsync, S3 and GitHub) and report generation (email, html, telegram).
+* Repository status interface with optional authorization and control options:
+
+    ![web interface](web.png)
 
 ## Installation and run
 
-* Install package as usual.
+For installation details kindly refer to the [documentation](https://ahriman.readthedocs.io/en/stable/setup.html). For application commands it is possible to get information by using `--help`/`help` command or by using man page ([web version](https://ahriman.readthedocs.io/en/stable/command-line.html)).
-* Change settings if required, see [CONFIGURING](CONFIGURING.md) for more details.
-* Create `/var/lib/ahriman/.makepkg.conf` with `makepkg.conf` overrides if required (at least you might want to set `PACKAGER`):
 
-    ```shell
+## Configuration
-    echo 'PACKAGES="John Doe <john@doe.com>"' | sudo -u ahriman tee -a /var/lib/ahriman/.makepkg.conf
-    ```
 
-* Configure build tools (it is required for correct dependency management system):
+Every available option is described in the [documentation](https://ahriman.readthedocs.io/en/stable/configuration.html).
 
-    * create build command, e.g. `ln -s /usr/bin/archbuild /usr/local/bin/ahriman-x86_64-build` (you can choose any name for command, basically it should be `{name}-{arch}-build`);
+The application provides reasonable defaults which allow to use it out-of-box; however additional steps (like configuring build toolchain and sudoers) are recommended and can be easily achieved by following install instructions.
-    * create configuration file, e.g. `cp /usr/share/devtools/pacman-{extra,ahriman}.conf` (same as previous `pacman-{name}.conf`);
-    * change configuration file, add your own repository, add multilib repository etc. Hint: you can use `Include` option as well;
-    * set `build_command` option to point to your command;
-    * configure `/etc/sudoers.d/ahriman` to allow running command without a password.
 
-    ```shell
+## [FAQ](https://ahriman.readthedocs.io/en/stable/faq.html)
-    ln -s /usr/bin/archbuild /usr/local/bin/ahriman-x86_64-build
-    cp /usr/share/devtools/pacman-{extra,ahriman}.conf
 
-    echo '[multilib]' | tee -a /usr/share/devtools/pacman-ahriman.conf
+## Live demos
-    echo 'Include = /etc/pacman.d/mirrorlist' | tee -a /usr/share/devtools/pacman-ahriman.conf
 
-    echo '[aur-clone]' | tee -a /usr/share/devtools/pacman-ahriman.conf
+* [Build status page](https://ahriman-demo.arcanis.me). You can log in as `demo` user by using `demo` password. However, you will not be able to run tasks. [HTTP API documentation](https://ahriman-demo.arcanis.me/api-docs) is also available.
-    echo 'SigLevel = Optional TrustAll' | tee -a /usr/share/devtools/pacman-ahriman.conf
+* [Repository index](https://repo.arcanis.me/arcanisrepo/x86_64/).
-    echo 'Server = file:///var/lib/ahriman/repository/$arch' | tee -a /usr/share/devtools/pacman-ahriman.conf
+* [Telegram feed](https://t.me/arcanisrepo).
-
-    echo '[build]' | tee -a /etc/ahriman.ini.d/build.ini
-    echo 'build_command = ahriman-x86_64-build' | tee -a /etc/ahriman.ini.d/build.ini
-
-    echo 'Cmnd_Alias CARCHBUILD_CMD = /usr/local/bin/ahriman-x86_64-build *' | tee -a /etc/sudoers.d/ahriman
-    echo 'ahriman ALL=(ALL) NOPASSWD: CARCHBUILD_CMD' | tee -a /etc/sudoers.d/ahriman
-    chmod 400 /etc/sudoers.d/ahriman
-    ```
-
-* Start and enable `ahriman@.timer` via `systemctl`:
-
-    ```shell
-    systemctl enable --now ahriman@x86_64.timer
-    ```
-
-* Start and enable status page:
-
-    ```shell
-    systemctl enable --now ahriman-web@x86_64
-    ```
-
-* Add packages by using `ahriman add {package}` command:
-
-    ```shell
-    sudo -u ahriman ahriman -a x86_64 add yay
-    ```

SECURITY.md

@@ -0,0 +1,9 @@
+# Security Policy
+
+## Supported Versions
+
+The project follows bleeding edge philosophy, thus only the latest version is supported with the exception for release candidates (i.e. tags which are marked with `rc` suffix).
+
+## Reporting a Vulnerability
+
+In the most cases you can report (suspected) security vulnerabilities directly on github by using ["Security report" template](https://github.com/arcan1s/ahriman/issues/new?assignees=&labels=security&template=02-security-report.md&title=). However, if your report could lead to data leak or break the system we kindly ask you to contact [current maintainer](AUTHORS) directly by email.

docker/entrypoint.sh

@@ -0,0 +1,72 @@
+#!/bin/bash
+
+set -e
+[ -n "$AHRIMAN_DEBUG" ] && set -x
+
+# configuration tune
+cat <<EOF > "/etc/ahriman.ini.d/00-docker.ini"
+[repository]
+root = $AHRIMAN_REPOSITORY_ROOT
+
+[settings]
+database = $AHRIMAN_REPOSITORY_ROOT/ahriman.db
+
+[web]
+host = $AHRIMAN_HOST
+
+EOF
+
+AHRIMAN_DEFAULT_ARGS=("--architecture" "$AHRIMAN_ARCHITECTURE")
+AHRIMAN_DEFAULT_ARGS+=("--repository" "$AHRIMAN_REPOSITORY")
+if [ -n "$AHRIMAN_OUTPUT" ]; then
+    AHRIMAN_DEFAULT_ARGS+=("--log-handler" "$AHRIMAN_OUTPUT")
+fi
+
+# create repository root inside the [[mounted]] directory and set correct ownership
+[ -d "$AHRIMAN_REPOSITORY_ROOT" ] || mkdir "$AHRIMAN_REPOSITORY_ROOT"
+chown "$AHRIMAN_USER":"$AHRIMAN_USER" "$AHRIMAN_REPOSITORY_ROOT"
+
+# create .gnupg directory which is required for keys
+AHRIMAN_GNUPG_HOME="$(getent passwd "$AHRIMAN_USER" | cut -d : -f 6)/.gnupg"
+[ -d "$AHRIMAN_GNUPG_HOME" ] || mkdir -m700 "$AHRIMAN_GNUPG_HOME"
+chown "$AHRIMAN_USER":"$AHRIMAN_USER" "$AHRIMAN_GNUPG_HOME"
+
+# run built-in setup command
+AHRIMAN_SETUP_ARGS=("--build-as-user" "$AHRIMAN_USER")
+AHRIMAN_SETUP_ARGS+=("--packager" "$AHRIMAN_PACKAGER")
+if [ -z "$AHRIMAN_MULTILIB" ]; then
+    AHRIMAN_SETUP_ARGS+=("--no-multilib")
+fi
+if [ -n "$AHRIMAN_PACMAN_MIRROR" ]; then
+    AHRIMAN_SETUP_ARGS+=("--mirror" "$AHRIMAN_PACMAN_MIRROR")
+fi
+if [ -n "$AHRIMAN_REPOSITORY_SERVER" ]; then
+    AHRIMAN_SETUP_ARGS+=("--server" "$AHRIMAN_REPOSITORY_SERVER")
+fi
+if [ -n "$AHRIMAN_PORT" ]; then
+    AHRIMAN_SETUP_ARGS+=("--web-port" "$AHRIMAN_PORT")
+fi
+if [ -n "$AHRIMAN_UNIX_SOCKET" ]; then
+    AHRIMAN_SETUP_ARGS+=("--web-unix-socket" "$AHRIMAN_UNIX_SOCKET")
+fi
+
+[ -n "$AHRIMAN_PRESETUP_COMMAND" ] && eval "$AHRIMAN_PRESETUP_COMMAND"
+ahriman "${AHRIMAN_DEFAULT_ARGS[@]}" service-setup "${AHRIMAN_SETUP_ARGS[@]}"
+[ -n "$AHRIMAN_POSTSETUP_COMMAND" ] && eval "$AHRIMAN_POSTSETUP_COMMAND"
+
+# validate configuration if set
+[ -n "$AHRIMAN_VALIDATE_CONFIGURATION" ] && ahriman "${AHRIMAN_DEFAULT_ARGS[@]}" service-config-validate --exit-code
+
+# create machine-id which is required by build tools
+systemd-machine-id-setup &> /dev/null
+
+# if AHRIMAN_FORCE_ROOT is set or command is unsafe we can run without sudo
+# otherwise we prepend executable by sudo command
+if [ -n "$AHRIMAN_FORCE_ROOT" ]; then
+    AHRIMAN_EXECUTABLE=("ahriman")
+elif ahriman help-commands-unsafe -- "$@" &> /dev/null; then
+    AHRIMAN_EXECUTABLE=("sudo" "-E" "-u" "$AHRIMAN_USER" "--" "ahriman")
+else
+    AHRIMAN_EXECUTABLE=("ahriman")
+fi
+exec "${AHRIMAN_EXECUTABLE[@]}" "${AHRIMAN_DEFAULT_ARGS[@]}" "$@"

docker/install-aur-package.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+set -e
+
+for PACKAGE in "$@"; do
+    BUILD_DIR="$(mktemp -d)"
+    git clone https://aur.archlinux.org/"$PACKAGE".git "$BUILD_DIR"
+    cd "$BUILD_DIR"
+    makepkg --noconfirm --install --rmdeps --syncdeps
+    cd /
+    rm -r "$BUILD_DIR"
+done

docker/systemd-nspawn.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+# Since https://gitlab.archlinux.org/archlinux/devtools/-/commit/5f4fd52e3836ddddb25a0f9e15d0acfed06f693d
+# it is impossible to start devtools inside docker container, because it requires slice registering
+# which is impossible because there is no init in container
+
+is_slice() {
+    [[ $1 =~ ^--slice* ]]
+}
+
+allowed=()
+for arg in "$@"; do
+    is_slice "$arg" && allowed+=("--keep-unit") || allowed+=("$arg")
+done
+
+exec /usr/bin/systemd-nspawn "${allowed[@]}"

docs/advanced-usage.rst

@@ -0,0 +1,45 @@
+Advanced usage
+==============
+
+Depending on the goal the package can be used in different ways. Nevertheless, in the most cases you will need some basic classes
+
+.. code-block:: python
+
+   from pathlib import Path
+
+   from ahriman.core.configuration import Configuration
+   from ahriman.core.database import SQLite
+   from ahriman.models.repository_id import RepositoryId
+
+   repository_id = RepositoryId("x86_64", "aur-clone")
+   configuration = Configuration.from_path(Path("/etc/ahriman.ini"), architecture)
+   database = SQLite.load(configuration)
+
+At this point there are ``configuration`` and ``database`` instances which can be used later at any time anywhere, e.g.
+
+.. code-block:: python
+
+   # instance of ``RepositoryPaths`` class
+   paths = configuration.repository_paths
+
+Almost all actions are wrapped by ``ahriman.core.repository.Repository`` class
+
+.. code-block:: python
+
+   from ahriman.core.repository import Repository
+   from ahriman.models.pacman_synchronization import PacmanSynchronization
+
+   repository = Repository(repository_id, configuration, database,
+                           report=True, refresh_pacman_database=PacmanSynchronization.Disabled)
+
+And the ``repository`` instance can be used to perform repository maintenance
+
+.. code-block:: python
+
+   build_result = repository.process_build(known_packages)
+   built_packages = repository.packages_built()
+   update_result = repository.process_update(built_packages)
+
+   repository.triggers.on_result(update_result, repository.packages())
+
+For the more info please refer to the classes documentation.

docs/ahriman.application.application.rst

@@ -0,0 +1,45 @@
+ahriman.application.application package
+=======================================
+
+Submodules
+----------
+
+ahriman.application.application.application module
+--------------------------------------------------
+
+.. automodule:: ahriman.application.application.application
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.application.application\_packages module
+------------------------------------------------------------
+
+.. automodule:: ahriman.application.application.application_packages
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.application.application\_properties module
+--------------------------------------------------------------
+
+.. automodule:: ahriman.application.application.application_properties
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.application.application\_repository module
+--------------------------------------------------------------
+
+.. automodule:: ahriman.application.application.application_repository
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.application.application
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.application.handlers.rst

@@ -0,0 +1,261 @@
+ahriman.application.handlers package
+====================================
+
+Submodules
+----------
+
+ahriman.application.handlers.add module
+---------------------------------------
+
+.. automodule:: ahriman.application.handlers.add
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.backup module
+------------------------------------------
+
+.. automodule:: ahriman.application.handlers.backup
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.clean module
+-----------------------------------------
+
+.. automodule:: ahriman.application.handlers.clean
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.daemon module
+------------------------------------------
+
+.. automodule:: ahriman.application.handlers.daemon
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.dump module
+----------------------------------------
+
+.. automodule:: ahriman.application.handlers.dump
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.handler module
+-------------------------------------------
+
+.. automodule:: ahriman.application.handlers.handler
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.help module
+----------------------------------------
+
+.. automodule:: ahriman.application.handlers.help
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.key\_import module
+-----------------------------------------------
+
+.. automodule:: ahriman.application.handlers.key_import
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.patch module
+-----------------------------------------
+
+.. automodule:: ahriman.application.handlers.patch
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.rebuild module
+-------------------------------------------
+
+.. automodule:: ahriman.application.handlers.rebuild
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.remove module
+------------------------------------------
+
+.. automodule:: ahriman.application.handlers.remove
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.remove\_unknown module
+---------------------------------------------------
+
+.. automodule:: ahriman.application.handlers.remove_unknown
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.repositories module
+------------------------------------------------
+
+.. automodule:: ahriman.application.handlers.repositories
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.restore module
+-------------------------------------------
+
+.. automodule:: ahriman.application.handlers.restore
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.run module
+---------------------------------------
+
+.. automodule:: ahriman.application.handlers.run
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.search module
+------------------------------------------
+
+.. automodule:: ahriman.application.handlers.search
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.service\_updates module
+----------------------------------------------------
+
+.. automodule:: ahriman.application.handlers.service_updates
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.setup module
+-----------------------------------------
+
+.. automodule:: ahriman.application.handlers.setup
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.shell module
+-----------------------------------------
+
+.. automodule:: ahriman.application.handlers.shell
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.sign module
+----------------------------------------
+
+.. automodule:: ahriman.application.handlers.sign
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.status module
+------------------------------------------
+
+.. automodule:: ahriman.application.handlers.status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.status\_update module
+--------------------------------------------------
+
+.. automodule:: ahriman.application.handlers.status_update
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.structure module
+---------------------------------------------
+
+.. automodule:: ahriman.application.handlers.structure
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.tree\_migrate module
+-------------------------------------------------
+
+.. automodule:: ahriman.application.handlers.tree_migrate
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.triggers module
+--------------------------------------------
+
+.. automodule:: ahriman.application.handlers.triggers
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.unsafe\_commands module
+----------------------------------------------------
+
+.. automodule:: ahriman.application.handlers.unsafe_commands
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.update module
+------------------------------------------
+
+.. automodule:: ahriman.application.handlers.update
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.users module
+-----------------------------------------
+
+.. automodule:: ahriman.application.handlers.users
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.validate module
+--------------------------------------------
+
+.. automodule:: ahriman.application.handlers.validate
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.versions module
+--------------------------------------------
+
+.. automodule:: ahriman.application.handlers.versions
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.handlers.web module
+---------------------------------------
+
+.. automodule:: ahriman.application.handlers.web
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.application.handlers
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.application.rst

@@ -0,0 +1,38 @@
+ahriman.application package
+===========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.application.application
+   ahriman.application.handlers
+
+Submodules
+----------
+
+ahriman.application.ahriman module
+----------------------------------
+
+.. automodule:: ahriman.application.ahriman
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.application.lock module
+-------------------------------
+
+.. automodule:: ahriman.application.lock
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.application
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.alpm.remote.rst

@@ -0,0 +1,45 @@
+ahriman.core.alpm.remote package
+================================
+
+Submodules
+----------
+
+ahriman.core.alpm.remote.aur module
+-----------------------------------
+
+.. automodule:: ahriman.core.alpm.remote.aur
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.alpm.remote.official module
+----------------------------------------
+
+.. automodule:: ahriman.core.alpm.remote.official
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.alpm.remote.official\_syncdb module
+------------------------------------------------
+
+.. automodule:: ahriman.core.alpm.remote.official_syncdb
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.alpm.remote.remote module
+--------------------------------------
+
+.. automodule:: ahriman.core.alpm.remote.remote
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.alpm.remote
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.alpm.rst

@@ -0,0 +1,37 @@
+ahriman.core.alpm package
+=========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.core.alpm.remote
+
+Submodules
+----------
+
+ahriman.core.alpm.pacman module
+-------------------------------
+
+.. automodule:: ahriman.core.alpm.pacman
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.alpm.repo module
+-----------------------------
+
+.. automodule:: ahriman.core.alpm.repo
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.alpm
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.auth.rst

@@ -0,0 +1,45 @@
+ahriman.core.auth package
+=========================
+
+Submodules
+----------
+
+ahriman.core.auth.auth module
+-----------------------------
+
+.. automodule:: ahriman.core.auth.auth
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.auth.helpers module
+--------------------------------
+
+.. automodule:: ahriman.core.auth.helpers
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.auth.mapping module
+--------------------------------
+
+.. automodule:: ahriman.core.auth.mapping
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.auth.oauth module
+------------------------------
+
+.. automodule:: ahriman.core.auth.oauth
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.auth
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.build_tools.rst

@@ -0,0 +1,29 @@
+ahriman.core.build\_tools package
+=================================
+
+Submodules
+----------
+
+ahriman.core.build\_tools.sources module
+----------------------------------------
+
+.. automodule:: ahriman.core.build_tools.sources
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.build\_tools.task module
+-------------------------------------
+
+.. automodule:: ahriman.core.build_tools.task
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.build_tools
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.configuration.rst

@@ -0,0 +1,45 @@
+ahriman.core.configuration package
+==================================
+
+Submodules
+----------
+
+ahriman.core.configuration.configuration module
+-----------------------------------------------
+
+.. automodule:: ahriman.core.configuration.configuration
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.configuration.schema module
+----------------------------------------
+
+.. automodule:: ahriman.core.configuration.schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.configuration.shell\_interpolator module
+-----------------------------------------------------
+
+.. automodule:: ahriman.core.configuration.shell_interpolator
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.configuration.validator module
+-------------------------------------------
+
+.. automodule:: ahriman.core.configuration.validator
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.configuration
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.database.migrations.rst

@@ -0,0 +1,109 @@
+ahriman.core.database.migrations package
+========================================
+
+Submodules
+----------
+
+ahriman.core.database.migrations.m000\_initial module
+-----------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m000_initial
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m001\_package\_source module
+-------------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m001_package_source
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m002\_user\_access module
+----------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m002_user_access
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m003\_patch\_variables module
+--------------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m003_patch_variables
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m004\_logs module
+--------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m004_logs
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m005\_make\_opt\_depends module
+----------------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m005_make_opt_depends
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m006\_packages\_architecture\_required module
+------------------------------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m006_packages_architecture_required
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m007\_check\_depends module
+------------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m007_check_depends
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m008\_packagers module
+-------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m008_packagers
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m009\_local\_source module
+-----------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m009_local_source
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m010\_version\_based\_logs\_removal module
+---------------------------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m010_version_based_logs_removal
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.migrations.m011\_repository\_name module
+--------------------------------------------------------------
+
+.. automodule:: ahriman.core.database.migrations.m011_repository_name
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.database.migrations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.database.operations.rst

@@ -0,0 +1,61 @@
+ahriman.core.database.operations package
+========================================
+
+Submodules
+----------
+
+ahriman.core.database.operations.auth\_operations module
+--------------------------------------------------------
+
+.. automodule:: ahriman.core.database.operations.auth_operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.operations.build\_operations module
+---------------------------------------------------------
+
+.. automodule:: ahriman.core.database.operations.build_operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.operations.logs\_operations module
+--------------------------------------------------------
+
+.. automodule:: ahriman.core.database.operations.logs_operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.operations.operations module
+--------------------------------------------------
+
+.. automodule:: ahriman.core.database.operations.operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.operations.package\_operations module
+-----------------------------------------------------------
+
+.. automodule:: ahriman.core.database.operations.package_operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.database.operations.patch\_operations module
+---------------------------------------------------------
+
+.. automodule:: ahriman.core.database.operations.patch_operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.database.operations
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.database.rst

@@ -0,0 +1,30 @@
+ahriman.core.database package
+=============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.core.database.migrations
+   ahriman.core.database.operations
+
+Submodules
+----------
+
+ahriman.core.database.sqlite module
+-----------------------------------
+
+.. automodule:: ahriman.core.database.sqlite
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.database
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.formatters.rst

@@ -0,0 +1,133 @@
+ahriman.core.formatters package
+===============================
+
+Submodules
+----------
+
+ahriman.core.formatters.aur\_printer module
+-------------------------------------------
+
+.. automodule:: ahriman.core.formatters.aur_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.build\_printer module
+---------------------------------------------
+
+.. automodule:: ahriman.core.formatters.build_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.configuration\_paths\_printer module
+------------------------------------------------------------
+
+.. automodule:: ahriman.core.formatters.configuration_paths_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.configuration\_printer module
+-----------------------------------------------------
+
+.. automodule:: ahriman.core.formatters.configuration_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.package\_printer module
+-----------------------------------------------
+
+.. automodule:: ahriman.core.formatters.package_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.patch\_printer module
+---------------------------------------------
+
+.. automodule:: ahriman.core.formatters.patch_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.printer module
+--------------------------------------
+
+.. automodule:: ahriman.core.formatters.printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.repository\_printer module
+--------------------------------------------------
+
+.. automodule:: ahriman.core.formatters.repository_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.status\_printer module
+----------------------------------------------
+
+.. automodule:: ahriman.core.formatters.status_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.string\_printer module
+----------------------------------------------
+
+.. automodule:: ahriman.core.formatters.string_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.tree\_printer module
+--------------------------------------------
+
+.. automodule:: ahriman.core.formatters.tree_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.update\_printer module
+----------------------------------------------
+
+.. automodule:: ahriman.core.formatters.update_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.user\_printer module
+--------------------------------------------
+
+.. automodule:: ahriman.core.formatters.user_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.validation\_printer module
+--------------------------------------------------
+
+.. automodule:: ahriman.core.formatters.validation_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.formatters.version\_printer module
+-----------------------------------------------
+
+.. automodule:: ahriman.core.formatters.version_printer
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.formatters
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.gitremote.rst

@@ -0,0 +1,45 @@
+ahriman.core.gitremote package
+==============================
+
+Submodules
+----------
+
+ahriman.core.gitremote.remote\_pull module
+------------------------------------------
+
+.. automodule:: ahriman.core.gitremote.remote_pull
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.gitremote.remote\_pull\_trigger module
+---------------------------------------------------
+
+.. automodule:: ahriman.core.gitremote.remote_pull_trigger
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.gitremote.remote\_push module
+------------------------------------------
+
+.. automodule:: ahriman.core.gitremote.remote_push
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.gitremote.remote\_push\_trigger module
+---------------------------------------------------
+
+.. automodule:: ahriman.core.gitremote.remote_push_trigger
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.gitremote
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.http.rst

@@ -0,0 +1,21 @@
+ahriman.core.http package
+=========================
+
+Submodules
+----------
+
+ahriman.core.http.sync\_http\_client module
+-------------------------------------------
+
+.. automodule:: ahriman.core.http.sync_http_client
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.http
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.log.rst

@@ -0,0 +1,53 @@
+ahriman.core.log package
+========================
+
+Submodules
+----------
+
+ahriman.core.log.filtered\_access\_logger module
+------------------------------------------------
+
+.. automodule:: ahriman.core.log.filtered_access_logger
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.log.http\_log\_handler module
+------------------------------------------
+
+.. automodule:: ahriman.core.log.http_log_handler
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.log.journal\_handler module
+----------------------------------------
+
+.. automodule:: ahriman.core.log.journal_handler
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.log.lazy\_logging module
+-------------------------------------
+
+.. automodule:: ahriman.core.log.lazy_logging
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.log.log\_loader module
+-----------------------------------
+
+.. automodule:: ahriman.core.log.log_loader
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.log
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.report.rst

@@ -0,0 +1,77 @@
+ahriman.core.report package
+===========================
+
+Submodules
+----------
+
+ahriman.core.report.console module
+----------------------------------
+
+.. automodule:: ahriman.core.report.console
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.report.email module
+--------------------------------
+
+.. automodule:: ahriman.core.report.email
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.report.html module
+-------------------------------
+
+.. automodule:: ahriman.core.report.html
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.report.jinja\_template module
+------------------------------------------
+
+.. automodule:: ahriman.core.report.jinja_template
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.report.remote\_call module
+---------------------------------------
+
+.. automodule:: ahriman.core.report.remote_call
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.report.report module
+---------------------------------
+
+.. automodule:: ahriman.core.report.report
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.report.report\_trigger module
+------------------------------------------
+
+.. automodule:: ahriman.core.report.report_trigger
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.report.telegram module
+-----------------------------------
+
+.. automodule:: ahriman.core.report.telegram
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.report
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.repository.rst

@@ -0,0 +1,53 @@
+ahriman.core.repository package
+===============================
+
+Submodules
+----------
+
+ahriman.core.repository.cleaner module
+--------------------------------------
+
+.. automodule:: ahriman.core.repository.cleaner
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.repository.executor module
+---------------------------------------
+
+.. automodule:: ahriman.core.repository.executor
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.repository.repository module
+-----------------------------------------
+
+.. automodule:: ahriman.core.repository.repository
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.repository.repository\_properties module
+-----------------------------------------------------
+
+.. automodule:: ahriman.core.repository.repository_properties
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.repository.update\_handler module
+----------------------------------------------
+
+.. automodule:: ahriman.core.repository.update_handler
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.repository
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.rst

@@ -0,0 +1,68 @@
+ahriman.core package
+====================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.core.alpm
+   ahriman.core.auth
+   ahriman.core.build_tools
+   ahriman.core.configuration
+   ahriman.core.database
+   ahriman.core.formatters
+   ahriman.core.gitremote
+   ahriman.core.http
+   ahriman.core.log
+   ahriman.core.report
+   ahriman.core.repository
+   ahriman.core.sign
+   ahriman.core.status
+   ahriman.core.support
+   ahriman.core.triggers
+   ahriman.core.upload
+
+Submodules
+----------
+
+ahriman.core.exceptions module
+------------------------------
+
+.. automodule:: ahriman.core.exceptions
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.spawn module
+-------------------------
+
+.. automodule:: ahriman.core.spawn
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.tree module
+------------------------
+
+.. automodule:: ahriman.core.tree
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.util module
+------------------------
+
+.. automodule:: ahriman.core.util
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.sign.rst

@@ -0,0 +1,21 @@
+ahriman.core.sign package
+=========================
+
+Submodules
+----------
+
+ahriman.core.sign.gpg module
+----------------------------
+
+.. automodule:: ahriman.core.sign.gpg
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.sign
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.status.rst

@@ -0,0 +1,37 @@
+ahriman.core.status package
+===========================
+
+Submodules
+----------
+
+ahriman.core.status.client module
+---------------------------------
+
+.. automodule:: ahriman.core.status.client
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.status.watcher module
+----------------------------------
+
+.. automodule:: ahriman.core.status.watcher
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.status.web\_client module
+--------------------------------------
+
+.. automodule:: ahriman.core.status.web_client
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.support.pkgbuild.rst

@@ -0,0 +1,37 @@
+ahriman.core.support.pkgbuild package
+=====================================
+
+Submodules
+----------
+
+ahriman.core.support.pkgbuild.keyring\_generator module
+-------------------------------------------------------
+
+.. automodule:: ahriman.core.support.pkgbuild.keyring_generator
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.support.pkgbuild.mirrorlist\_generator module
+----------------------------------------------------------
+
+.. automodule:: ahriman.core.support.pkgbuild.mirrorlist_generator
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.support.pkgbuild.pkgbuild\_generator module
+--------------------------------------------------------
+
+.. automodule:: ahriman.core.support.pkgbuild.pkgbuild_generator
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.support.pkgbuild
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.support.rst

@@ -0,0 +1,45 @@
+ahriman.core.support package
+============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.core.support.pkgbuild
+
+Submodules
+----------
+
+ahriman.core.support.keyring\_trigger module
+--------------------------------------------
+
+.. automodule:: ahriman.core.support.keyring_trigger
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.support.mirrorlist\_trigger module
+-----------------------------------------------
+
+.. automodule:: ahriman.core.support.mirrorlist_trigger
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.support.package\_creator module
+--------------------------------------------
+
+.. automodule:: ahriman.core.support.package_creator
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.support
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.triggers.rst

@@ -0,0 +1,29 @@
+ahriman.core.triggers package
+=============================
+
+Submodules
+----------
+
+ahriman.core.triggers.trigger module
+------------------------------------
+
+.. automodule:: ahriman.core.triggers.trigger
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.triggers.trigger\_loader module
+--------------------------------------------
+
+.. automodule:: ahriman.core.triggers.trigger_loader
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.triggers
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.core.upload.rst

@@ -0,0 +1,69 @@
+ahriman.core.upload package
+===========================
+
+Submodules
+----------
+
+ahriman.core.upload.github module
+---------------------------------
+
+.. automodule:: ahriman.core.upload.github
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.upload.http\_upload module
+---------------------------------------
+
+.. automodule:: ahriman.core.upload.http_upload
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.upload.remote\_service module
+------------------------------------------
+
+.. automodule:: ahriman.core.upload.remote_service
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.upload.rsync module
+--------------------------------
+
+.. automodule:: ahriman.core.upload.rsync
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.upload.s3 module
+-----------------------------
+
+.. automodule:: ahriman.core.upload.s3
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.upload.upload module
+---------------------------------
+
+.. automodule:: ahriman.core.upload.upload
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.core.upload.upload\_trigger module
+------------------------------------------
+
+.. automodule:: ahriman.core.upload.upload_trigger
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.core.upload
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.models.rst

@@ -0,0 +1,253 @@
+ahriman.models package
+======================
+
+Submodules
+----------
+
+ahriman.models.action module
+----------------------------
+
+.. automodule:: ahriman.models.action
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.aur\_package module
+----------------------------------
+
+.. automodule:: ahriman.models.aur_package
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.auth\_settings module
+------------------------------------
+
+.. automodule:: ahriman.models.auth_settings
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.build\_status module
+-----------------------------------
+
+.. automodule:: ahriman.models.build_status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.context\_key module
+----------------------------------
+
+.. automodule:: ahriman.models.context_key
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.counters module
+------------------------------
+
+.. automodule:: ahriman.models.counters
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.internal\_status module
+--------------------------------------
+
+.. automodule:: ahriman.models.internal_status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.log\_handler module
+----------------------------------
+
+.. automodule:: ahriman.models.log_handler
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.log\_record\_id module
+-------------------------------------
+
+.. automodule:: ahriman.models.log_record_id
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.migration module
+-------------------------------
+
+.. automodule:: ahriman.models.migration
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.migration\_result module
+---------------------------------------
+
+.. automodule:: ahriman.models.migration_result
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.package module
+-----------------------------
+
+.. automodule:: ahriman.models.package
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.package\_description module
+------------------------------------------
+
+.. automodule:: ahriman.models.package_description
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.package\_source module
+-------------------------------------
+
+.. automodule:: ahriman.models.package_source
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.packagers module
+-------------------------------
+
+.. automodule:: ahriman.models.packagers
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.pacman\_synchronization module
+---------------------------------------------
+
+.. automodule:: ahriman.models.pacman_synchronization
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.pkgbuild\_patch module
+-------------------------------------
+
+.. automodule:: ahriman.models.pkgbuild_patch
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.process\_status module
+-------------------------------------
+
+.. automodule:: ahriman.models.process_status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.property module
+------------------------------
+
+.. automodule:: ahriman.models.property
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.remote\_source module
+------------------------------------
+
+.. automodule:: ahriman.models.remote_source
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.report\_settings module
+--------------------------------------
+
+.. automodule:: ahriman.models.report_settings
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.repository\_id module
+------------------------------------
+
+.. automodule:: ahriman.models.repository_id
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.repository\_paths module
+---------------------------------------
+
+.. automodule:: ahriman.models.repository_paths
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.result module
+----------------------------
+
+.. automodule:: ahriman.models.result
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.sign\_settings module
+------------------------------------
+
+.. automodule:: ahriman.models.sign_settings
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.smtp\_ssl\_settings module
+-----------------------------------------
+
+.. automodule:: ahriman.models.smtp_ssl_settings
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.upload\_settings module
+--------------------------------------
+
+.. automodule:: ahriman.models.upload_settings
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.user module
+--------------------------
+
+.. automodule:: ahriman.models.user
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.user\_access module
+----------------------------------
+
+.. automodule:: ahriman.models.user_access
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.models.waiter module
+----------------------------
+
+.. automodule:: ahriman.models.waiter
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.models
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.rst

@@ -0,0 +1,21 @@
+ahriman package
+===============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.application
+   ahriman.core
+   ahriman.models
+   ahriman.web
+
+Module contents
+---------------
+
+.. automodule:: ahriman
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.middlewares.rst

@@ -0,0 +1,29 @@
+ahriman.web.middlewares package
+===============================
+
+Submodules
+----------
+
+ahriman.web.middlewares.auth\_handler module
+--------------------------------------------
+
+.. automodule:: ahriman.web.middlewares.auth_handler
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.middlewares.exception\_handler module
+-------------------------------------------------
+
+.. automodule:: ahriman.web.middlewares.exception_handler
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.middlewares
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.rst

@@ -0,0 +1,55 @@
+ahriman.web package
+===================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.web.middlewares
+   ahriman.web.schemas
+   ahriman.web.views
+
+Submodules
+----------
+
+ahriman.web.apispec module
+--------------------------
+
+.. automodule:: ahriman.web.apispec
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.cors module
+-----------------------
+
+.. automodule:: ahriman.web.cors
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.routes module
+-------------------------
+
+.. automodule:: ahriman.web.routes
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.web module
+----------------------
+
+.. automodule:: ahriman.web.web
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.schemas.rst

@@ -0,0 +1,245 @@
+ahriman.web.schemas package
+===========================
+
+Submodules
+----------
+
+ahriman.web.schemas.aur\_package\_schema module
+-----------------------------------------------
+
+.. automodule:: ahriman.web.schemas.aur_package_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.auth\_schema module
+---------------------------------------
+
+.. automodule:: ahriman.web.schemas.auth_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.counters\_schema module
+-------------------------------------------
+
+.. automodule:: ahriman.web.schemas.counters_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.error\_schema module
+----------------------------------------
+
+.. automodule:: ahriman.web.schemas.error_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.file\_schema module
+---------------------------------------
+
+.. automodule:: ahriman.web.schemas.file_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.internal\_status\_schema module
+---------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.internal_status_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.log\_schema module
+--------------------------------------
+
+.. automodule:: ahriman.web.schemas.log_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.login\_schema module
+----------------------------------------
+
+.. automodule:: ahriman.web.schemas.login_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.logs\_schema module
+---------------------------------------
+
+.. automodule:: ahriman.web.schemas.logs_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.oauth2\_schema module
+-----------------------------------------
+
+.. automodule:: ahriman.web.schemas.oauth2_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.package\_name\_schema module
+------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.package_name_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.package\_names\_schema module
+-------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.package_names_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.package\_patch\_schema module
+-------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.package_patch_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.package\_properties\_schema module
+------------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.package_properties_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.package\_schema module
+------------------------------------------
+
+.. automodule:: ahriman.web.schemas.package_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.package\_status\_schema module
+--------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.package_status_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.pagination\_schema module
+---------------------------------------------
+
+.. automodule:: ahriman.web.schemas.pagination_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.patch\_name\_schema module
+----------------------------------------------
+
+.. automodule:: ahriman.web.schemas.patch_name_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.patch\_schema module
+----------------------------------------
+
+.. automodule:: ahriman.web.schemas.patch_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.pgp\_key\_id\_schema module
+-----------------------------------------------
+
+.. automodule:: ahriman.web.schemas.pgp_key_id_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.pgp\_key\_schema module
+-------------------------------------------
+
+.. automodule:: ahriman.web.schemas.pgp_key_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.process\_id\_schema module
+----------------------------------------------
+
+.. automodule:: ahriman.web.schemas.process_id_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.process\_schema module
+------------------------------------------
+
+.. automodule:: ahriman.web.schemas.process_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.remote\_schema module
+-----------------------------------------
+
+.. automodule:: ahriman.web.schemas.remote_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.repository\_id\_schema module
+-------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.repository_id_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.search\_schema module
+-----------------------------------------
+
+.. automodule:: ahriman.web.schemas.search_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.status\_schema module
+-----------------------------------------
+
+.. automodule:: ahriman.web.schemas.status_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.update\_flags\_schema module
+------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.update_flags_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.schemas.versioned\_log\_schema module
+-------------------------------------------------
+
+.. automodule:: ahriman.web.schemas.versioned_log_schema
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.schemas
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.views.api.rst

@@ -0,0 +1,29 @@
+ahriman.web.views.api package
+=============================
+
+Submodules
+----------
+
+ahriman.web.views.api.docs module
+---------------------------------
+
+.. automodule:: ahriman.web.views.api.docs
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.api.swagger module
+------------------------------------
+
+.. automodule:: ahriman.web.views.api.swagger
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views.api
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.views.rst

@@ -0,0 +1,47 @@
+ahriman.web.views package
+=========================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.web.views.api
+   ahriman.web.views.v1
+   ahriman.web.views.v2
+
+Submodules
+----------
+
+ahriman.web.views.base module
+-----------------------------
+
+.. automodule:: ahriman.web.views.base
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.index module
+------------------------------
+
+.. automodule:: ahriman.web.views.index
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.static module
+-------------------------------
+
+.. automodule:: ahriman.web.views.static
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.views.v1.rst

@@ -0,0 +1,20 @@
+ahriman.web.views.v1 package
+============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.web.views.v1.service
+   ahriman.web.views.v1.status
+   ahriman.web.views.v1.user
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views.v1
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.views.v1.service.rst

@@ -0,0 +1,85 @@
+ahriman.web.views.v1.service package
+====================================
+
+Submodules
+----------
+
+ahriman.web.views.v1.service.add module
+---------------------------------------
+
+.. automodule:: ahriman.web.views.v1.service.add
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.service.pgp module
+---------------------------------------
+
+.. automodule:: ahriman.web.views.v1.service.pgp
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.service.process module
+-------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.service.process
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.service.rebuild module
+-------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.service.rebuild
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.service.remove module
+------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.service.remove
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.service.request module
+-------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.service.request
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.service.search module
+------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.service.search
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.service.update module
+------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.service.update
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.service.upload module
+------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.service.upload
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views.v1.service
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.views.v1.status.rst

@@ -0,0 +1,69 @@
+ahriman.web.views.v1.status package
+===================================
+
+Submodules
+----------
+
+ahriman.web.views.v1.status.logs module
+---------------------------------------
+
+.. automodule:: ahriman.web.views.v1.status.logs
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.status.package module
+------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.status.package
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.status.packages module
+-------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.status.packages
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.status.patch module
+----------------------------------------
+
+.. automodule:: ahriman.web.views.v1.status.patch
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.status.patches module
+------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.status.patches
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.status.repositories module
+-----------------------------------------------
+
+.. automodule:: ahriman.web.views.v1.status.repositories
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.status.status module
+-----------------------------------------
+
+.. automodule:: ahriman.web.views.v1.status.status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views.v1.status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.views.v1.user.rst

@@ -0,0 +1,29 @@
+ahriman.web.views.v1.user package
+=================================
+
+Submodules
+----------
+
+ahriman.web.views.v1.user.login module
+--------------------------------------
+
+.. automodule:: ahriman.web.views.v1.user.login
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+ahriman.web.views.v1.user.logout module
+---------------------------------------
+
+.. automodule:: ahriman.web.views.v1.user.logout
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views.v1.user
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.views.v2.rst

@@ -0,0 +1,18 @@
+ahriman.web.views.v2 package
+============================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman.web.views.v2.status
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views.v2
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/ahriman.web.views.v2.status.rst

@@ -0,0 +1,21 @@
+ahriman.web.views.v2.status package
+===================================
+
+Submodules
+----------
+
+ahriman.web.views.v2.status.logs module
+---------------------------------------
+
+.. automodule:: ahriman.web.views.v2.status.logs
+   :members:
+   :no-undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: ahriman.web.views.v2.status
+   :members:
+   :no-undoc-members:
+   :show-inheritance:

docs/architecture.rst

@@ -0,0 +1,396 @@
+Architecture
+============
+
+Package structure
+-----------------
+
+Packages have strict rules of importing:
+
+* ``ahriman.application`` package must not be used anywhere except for itself.
+* ``ahriman.core`` and ``ahriman.models`` packages don't have any import restriction. Actually we would like to totally restrict importing of ``core`` package from ``models``, but it is impossible at the moment.
+* ``ahriman.web`` package is allowed to be imported from ``ahriman.application`` (web handler only, only ``ahriman.web.web`` methods). It also must not be imported globally, only local import is allowed. 
+
+Full dependency diagram:
+
+.. image:: ahriman-architecture.svg
+   :target: _images/ahriman-architecture.svg
+   :alt: architecture
+
+``ahriman.application`` package
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This package contains application (aka executable) related classes and everything for it. It also contains package called ``ahriman.application.handlers`` in which all available subcommands are described as separated classes derived from base ``ahriman.application.handlers.Handler`` class.
+
+``ahriman.application.application.Application`` (god class) is used for any interaction from parsers with repository. It is divided into multiple traits by functions (package related and repository related) in the same package.
+
+``ahriman.application.ahriman`` contains only command line parses and executes specified ``Handler`` on success, ``ahriman.application.lock.Lock`` is additional class which provides file-based lock and also performs some common checks.
+
+``ahriman.core`` package
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+This package contains everything required for the most of application actions and it is separated into several packages:
+
+* ``ahriman.core.alpm`` package controls pacman related functions. It provides wrappers for ``pyalpm`` library and safe calls for repository tools (``repo-add`` and ``repo-remove``). Also this package contains ``ahriman.core.alpm.remote`` package which provides wrapper for remote sources (e.g. AUR RPC and official repositories RPC).
+* ``ahriman.core.auth`` package provides classes for authorization methods used by web mostly. Base class is ``ahriman.core.auth.Auth`` which must be called by ``load`` method.
+* ``ahriman.core.build_tools`` is a package which provides wrapper for ``devtools`` commands.
+* ``ahriman.core.configuration`` contains extension for standard ``configparser`` library and some validation related classes.
+* ``ahriman.core.database`` is everything including data and schema migrations for database.
+* ``ahriman.core.formatters`` package provides ``Printer`` sub-classes for printing data (e.g. package properties) to stdout which are used by some handlers.
+* ``ahriman.core.gitremote`` is a package with remote PKGBUILD triggers. Should not be called directly.
+* ``ahriman.core.http`` package provides HTTP clients which can be later used by other classes.
+* ``ahriman.core.log`` is a log utils package. It includes logger loader class, custom HTTP based logger and access logger for HTTP services with additional filters.
+* ``ahriman.core.report`` is a package with reporting triggers. Should not be called directly.
+* ``ahriman.core.repository`` contains several traits and base repository (``ahriman.core.repository.Repository`` class) implementation.
+* ``ahriman.core.sign`` package provides sign feature (only gpg calls are available).
+* ``ahriman.core.status`` contains helpers and watcher class which are required for web application. Reporter must be initialized by using ``ahriman.core.status.client.Client.load`` method.
+* ``ahriman.core.support`` provides plugins for support packages (mirrorlist and keyring) generation.
+* ``ahriman.core.triggers`` package contains base trigger classes. Classes from this package must be imported in order to implement user extensions. In fact, ``ahriman.core.report``, ``ahriman.core.upload`` and other built-in triggers use this package.
+* ``ahriman.core.upload`` package provides sync feature, should not be called directly.
+
+This package also provides some generic functions and classes which may be used by other packages:
+
+* ``ahriman.core.exceptions`` provides custom exceptions.
+* ``ahriman.core.spawn.Spawn`` is a tool which can spawn another ``ahriman`` process. This feature is used by web application.
+* ``ahriman.core.tree`` is a dependency tree implementation.
+
+``ahriman.models`` package
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+It provides models for any other part of application. Unlike ``ahriman.core`` package classes from here provide only conversion methods (e.g. create class from another or convert to). It is mostly presented by case classes and enumerations.
+
+``ahriman.web`` package
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Web application. It is important that this package is isolated from any other to allow it to be optional feature (i.e. dependencies which are required by the package are optional).
+
+* ``ahriman.web.middlewares`` provides middlewares for request handlers.
+* ``ahriman.web.schemas`` provides schemas (actually copy paste from dataclasses) used by swagger documentation.
+* ``ahriman.web.views`` contains web views derived from aiohttp view class.
+* ``ahriman.web.apispec`` provides generators for swagger documentation.
+* ``ahriman.web.cors`` contains helpers for cross origin resource sharing middlewares.
+* ``ahriman.web.routes`` creates routes for web application.
+* ``ahriman.web.web`` provides main web application functions (e.g. start, initialization).
+
+Application run
+---------------
+
+#. Parse command line arguments, find subcommand and related handler which is set by the parser.
+#. Call ``Handler.execute`` method.
+#. Define list of architectures to run. In case if there is more than one architecture specified run several subprocesses or continue in current process otherwise. Class attribute ``ALLOW_MULTI_ARCHITECTURE_RUN`` controls whether the application can be run in multiple processes or not - this feature is required for some handlers (e.g. ``Web``, which should be able to spawn child process in daemon mode; it is impossible to do from daemonic processes).
+#. In each child process call lock functions.
+#. After success checks pass control to ``Handler.run`` method defined by specific handler class.
+#. Return result (success or failure) of each subprocess and exit from application.
+#. Some handlers may override their status and throw ``ExitCode`` exception. This exception is just silently suppressed and changes application exit code to ``1``.
+
+In the most cases handlers spawn god class ``ahriman.application.application.Application`` class and call required methods.
+
+The application is designed to run from ``systemd`` services and provides parametrized by repository identifier timer and service file for that.
+
+Subcommand design
+^^^^^^^^^^^^^^^^^
+
+All subcommands are divided into several groups depending on the role they are doing:
+
+* ``aur`` (``aur-search``) group is for AUR operations.
+* ``help`` (e.g. ``help``) are system commands.
+* ``package`` subcommands (e.g. ``package-add``) allow to perform single package actions.
+* ``patch`` subcommands (e.g. ``pacth-list``) are the special case of ``package`` subcommands introduced in order to control patches for packages.
+* ``repo`` subcommands (e.g. ``repo-check``) usually perform actions on whole repository.
+* ``service`` subcommands (e.g. ``service-setup``) perform actions which are related to whole service managing: create repository, show configuration.
+* ``user`` subcommands (``user-add``) are intended for user management.
+* ``web`` subcommands are related to web service management.
+
+For historical reasons and in order to keep backward compatibility some subcommands have aliases to their shorter forms or even other groups, but the application doesn't guarantee that they will remain unchanged.
+
+Filesystem tree
+---------------
+
+The application supports two types of trees, one is for the legacy configuration (when there were no repository name explicit configuration available) and another one is the new-style tree. This document describes only new-style tree in order to avoid deprecated structures.
+
+Having default root as ``/var/lib/ahriman`` (differs from container though), the directory structure is the following:
+
+.. code-block::
+
+   /var/lib/ahriman/
+   ├── ahriman.db
+   ├── cache
+   ├── chroot
+   │   └── aur-clone
+   ├── packages
+   │   └── aur-clone
+   │       └── x86_64
+   ├── pacman
+   │   └── aur-clone
+   │       └── x86_64
+   │           ├── local
+   │           │   └── ALPM_DB_VERSION
+   │           └── sync
+   │               ├── core.db
+   │               ├── extra.db
+   │               └── multilib.db
+   │
+   └── repository
+       └── aur-clone
+           └── x86_64
+               ├── aur-clone.db -> aur-clone.db.tar.gz
+               ├── aur-clone.db.tar.gz
+               ├── aur-clone.files -> aur-clone.files.tar.gz
+               └── aur-clone.files.tar.gz
+
+There are multiple subdirectories, some of them are commons for any repository, but some of them are not.
+
+* ``cache`` is a directory with locally stored PKGBUILD's and VCS packages. It is common for all repositories and architectures.
+* ``chroot/{repository}`` is a chroot directory for ``devtools``. It is specific for each repository, but shared for different architectures inside (the ``devtools`` handles architectures automatically).
+* ``packages/{repository}/{architecture}`` is a directory with prebuilt packages. When package is built, first it will be uploaded to this directory and later will be handled by update process. It is architecture and repository specific.
+* ``pacman/{repository}/{architecture}`` is the repository and architecture specific caches for pacman's databases.
+* ``repository/{repository}/{architecture}`` is a repository packages directory.
+
+Normally you should avoid direct interaction with the application tree. For tree migration process refer to the :doc:`migration notes <migration>`.
+
+Database
+--------
+
+The service uses SQLite database in order to store some internal info.
+
+Database instance
+^^^^^^^^^^^^^^^^^
+
+All methods related to specific part of database (basically operations per table) are split into different traits located inside ``ahriman.core.database.operations`` package. The base trait ``ahriman.core.database.operations.Operations`` also provides generic methods for database access (e.g. row converters and transactional support).
+
+The ``ahriman.core.database.SQLite`` class itself derives from all of these traits and implements methods for initialization, including migrations.
+
+Schema and data migrations
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The schema migration are applied according to current ``pragma user_info`` values, located at ``ahriman.core.database.migrations`` package and named as ``m000_migration_name.py`` (the preceding ``m`` is required in order to import migration content for tests). Additional class ``ahriman.core.database.migrations.Migrations`` reads all migrations automatically and applies them in alphabetical order.
+
+These migrations can also contain data migrations. Though the recommended way is to migrate data directly from SQL requests, sometimes it is required to have external data (like packages list) in order to set correct data. To do so, special method ``migrate_data`` is used.
+
+Type conversions
+^^^^^^^^^^^^^^^^
+
+By default, it parses rows into python dictionary. In addition, the following pseudo-types are supported:
+
+* ``dict[str, Any]``, ``list[Any]`` - for storing JSON data structures in database (technically there is no restriction on types for dictionary keys and values, but it is recommended to use only string keys). The type is stored as ``json`` data type and ``json.loads`` and ``json.dumps`` methods are used in order to read and write from/to database respectively.
+
+Basic flows
+-----------
+
+By default package build operations are performed with ``PACKAGER`` which is specified in ``makepkg.conf``, however, it is possible to override this variable from command line; in this case service performs lookup in the following way:
+
+* If packager is not set, it reads environment variables (e.g. ``SUDO_USER`` and ``USER``), otherwise it uses value from command line.
+* It checks users for the specified username and tries to extract packager variable from it.
+* If packager value has been found, it will be passed as ``PACKAGER`` system variable (sudo configuration required).
+
+Add new packages or rebuild existing
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Idea is to copy package to the directory from which it will be handled at the next update run. Different variants are supported:
+
+* If supplied argument is file then application moves the file to the directory with built packages. Same rule applies for directory, but in this case it copies every package-like file from the specified directory.
+* If supplied argument is directory and there is ``PKGBUILD`` file there it will be treated as local package. In this case it will queue this package to build and copy source files (``PKGBUILD`` and ``.SRCINFO``) to caches.
+* If supplied argument is not file then application tries to lookup for the specified name in AUR and clones it into the directory with manual updates. This scenario can also handle package dependencies which are missing in repositories.
+
+This logic can be overwritten by specifying the ``source`` parameter, which is partially useful if you would like to add package from AUR, but there is local directory cloned from AUR. Also official repositories calls are hidden behind explicit source definition.
+
+Rebuild packages
+^^^^^^^^^^^^^^^^
+
+Same as add function for every package in repository. Optional filters by reverse dependency or build status can be supplied.
+
+Remove packages
+^^^^^^^^^^^^^^^
+
+This flow removes package from filesystem, updates repository database and also runs synchronization and reporting methods.
+
+Update packages
+^^^^^^^^^^^^^^^
+
+This feature is divided into to stages: check AUR for updates and run rebuild for required packages. Whereas check does not do anything except for check itself, update flow is the following:
+
+#. Process every built package first. Those packages are usually added manually.
+#. Run sync and report methods.
+#. Generate dependency tree for packages to be built.
+#. For each level of tree it does:
+
+   #. Download package data from AUR.
+   #. Bump ``pkgrel`` if there is duplicate version in the local repository (see explanation below).
+   #. Build every package in clean chroot.
+   #. Sign packages if required.
+   #. Add packages to database and sign database if required.
+   #. Process triggers.
+
+After any step any package data is being removed.
+
+pkgrel bump rules
+^^^^^^^^^^^^^^^^^
+
+The application is able to automatically bump package release (``pkgrel``) during build process if there is duplicate version in repository. The version will be incremented as following:
+
+#. Get version of the remote package.
+#. Get version of the local package if any.
+#. If local version is not set, proceed with remote one.
+#. If local version is set and epoch or package version (``pkgver``) are different, proceed with remote version.
+#. If local version is set and remote version is newer than local one, proceed with remote.
+#. Extract ``pkgrel`` value.
+#. If it has ``major.minor`` notation (e.g. ``1.1``), then increment last part by 1, e.g. ``1.1 -> 1.2``, ``1.0.1 -> 1.0.2``.
+#. If ``pkgrel`` is a number (e.g. ``1``), then append 1 to the end of the string, e.g. ``1 -> 1.1``.
+
+Core functions reference
+------------------------
+
+Configuration
+^^^^^^^^^^^^^
+
+``ahriman.core.configuration.Configuration`` class provides some additional methods (e.g. ``getpath`` and ``getlist``) and also combines multiple files into single configuration dictionary using repository identifier overrides. It is the recommended way to deal with settings.
+
+Enumerations
+^^^^^^^^^^^^
+
+All enumerations are derived from ``str`` and ``enum.Enum``. Integer enumerations in general are not allowed, because most of operations require conversions from string variable. Derivation from string class is required to make json conversions implicitly (e.g. during calling ``json.dumps`` methods).
+
+In addition, some enumerations provide ``from_option`` class methods in order to allow some flexibility while reading configuration options.
+
+Utils
+^^^^^
+
+For every external command run (which is actually not recommended if possible) custom wrapper for ``subprocess`` is used. Additional functions ``ahriman.core.auth.helpers`` provide safe calls for ``aiohttp_security`` methods and are required to make this dependency optional.
+
+Context variables
+^^^^^^^^^^^^^^^^^
+
+Package provides implicit global variables which can be accessed from ``ahriman.core`` package as ``context`` variable, wrapped by ``contextvars.ContextVar`` class. The value of the variable is defaulting to private ``_Context`` class which is defined in the same module. The default values - such as ``database`` and ``sign`` - are being set on the service initialization.
+
+The ``_Context`` class itself mimics default collection interface (as is ``Mapping``) and can be modified by ``_Context.set`` method. The stored variables can be achieved by ``_Context.get`` method, which is unlike default ``Mapping`` interface also performs type and presence checks.
+
+In order to provide statically typed interface, the ``ahriman.models.context_key.ContextKey`` class is used for both ``_Content.get`` and ``_Content.set`` methods; the context instance itself, however, does not store information about types.
+
+Submodules
+^^^^^^^^^^
+
+Some packages provide different behaviour depending on configuration settings. In these cases inheritance is used and recommended way to deal with them is to call class method ``load`` from base classes.
+
+Authorization
+^^^^^^^^^^^^^
+
+The package provides several authorization methods: disabled, based on configuration and OAuth2. 
+
+Disabled (default) authorization provider just allows everything for everyone and does not have any specific configuration (it uses some default configuration parameters though). It also provides generic interface for derived classes.
+
+Mapping (aka configuration) provider uses hashed passwords with optional salt from the database in order to authenticate users. This provider also enables user permission checking (read/write) (authorization). Thus, it defines the following methods:
+
+* ``check_credentials`` - user password validation (authentication).
+* ``verify_access`` - user permission validation (authorization).
+
+Passwords must be stored in database as ``hash(password + salt)``, where ``password`` is user defined password (taken from user input), ``salt`` is random string (any length) defined globally in configuration and ``hash`` is secure hash function. Thus, the following configuration
+
+.. code-block::
+
+   "username","password","access"
+   "username","$6$rounds=656000$mWBiecMPrHAL1VgX$oU4Y5HH8HzlvMaxwkNEJjK13ozElyU1wAHBoO/WW5dAaE4YEfnB0X3FxbynKMl4FBdC3Ovap0jINz4LPkNADg0","read"
+
+means that there is user ``username`` with ``read`` access and password ``password`` hashed by ``sha512`` with salt ``salt``.
+
+OAuth provider uses library definitions (``aioauth-client``) in order *authenticate* users. It still requires user permission to be set in database, thus it inherits mapping provider without any changes. Whereas we could override ``check_credentials`` (authentication method) by something custom, OAuth flow is a bit more complex than just forward request, thus we have to implement the flow in login form.
+
+OAuth's implementation also allows authenticating users via username + password (in the same way as mapping does) though it is not recommended for end-users and password must be left blank. In particular this feature can be used by service reporting (aka robots).
+
+In addition, web service checks the source socket used. In case if it belongs to ``socket.AF_UNIX`` family, it will skip any further checks considering the request to be performed in safe environment (e.g. on the same physical machine). This feature, in particular is being used by the reporter instances in case if socket address is set in configuration.
+
+In order to configure users there are special subcommands.
+
+Triggers
+^^^^^^^^
+
+Triggers are extensions which can be used in order to perform any actions on application start, after the update process and, finally, before the application exit.
+
+The main idea is to load classes by their full path (e.g. ``ahriman.core.upload.UploadTrigger``) by using ``importlib``: get the last part of the import and treat it as class name, join remain part by ``.`` and interpret as module path, import module and extract attribute from it.
+
+The loaded triggers will be called with ``ahriman.models.result.Result`` and ``list[Packages]`` arguments, which describes the process result and current repository packages respectively. Any exception raised will be suppressed and will generate an exception message in logs.
+
+In addition triggers can implement ``on_start`` and ``on_stop`` actions which will be called on the application start and right before the application exit respectively. The ``on_start`` action is usually being called from handlers directly in order to make sure that no trigger will be run when it is not required (e.g. on user management). As soon as ``on_start`` action is called, the additional flag will be set; ``ahriman.core.triggers.TriggerLoader`` class implements ``__del__`` method in which, if the flag is set, the ``on_stop`` actions will be called.
+
+For more details how to deal with the triggers, refer to :doc:`documentation <triggers>` and modules descriptions.
+
+Remote synchronization
+^^^^^^^^^^^^^^^^^^^^^^
+
+There are several supported synchronization providers, currently they are ``rsync``, ``s3``, ``github``.
+
+``rsync`` provider does not have any specific logic except for running external rsync application with configured arguments. The service does not handle SSH configuration, thus it has to be configured before running application manually.
+
+``s3`` provider uses ``boto3`` package and implements sync feature. The files are stored in architecture directory (e.g. if bucket is ``repository``, packages will be stored in ``repository/aur-clone/x86_64`` for the ``aur-clone`` repository ``x86_64`` architecture), bucket must be created before any action and API key must have permissions to write to the bucket. No external configuration required. In order to upload only changed files the service compares calculated hashes with the Amazon ETags, used realization is described `here <https://teppen.io/2018/10/23/aws_s3_verify_etags/>`_.
+
+``github`` provider authenticates through basic auth, API key with repository write permissions is required. There will be created a release with the name of the architecture in case if it does not exist; files will be uploaded to the release assets. It also stores array of files and their MD5 checksums in release body in order to upload only changed ones. According to the Github API in case if there is already uploaded asset with the same name (e.g. database files), asset will be removed first.
+
+Additional features
+^^^^^^^^^^^^^^^^^^^
+
+Some features require optional dependencies to be installed:
+
+* Version control executables (e.g. ``git``, ``svn``) for VCS packages.
+* ``gnupg`` application for package and repository sign feature.
+* ``rsync`` application for rsync based repository sync.
+* ``boto3`` python package for ``S3`` sync.
+* ``Jinja2`` python package for HTML report generation (it is also used by web application).
+
+Web application
+---------------
+
+Web application requires the following python packages to be installed:
+
+* Core part requires ``aiohttp`` (application itself), ``aiohttp_jinja2`` and ``Jinja2`` (HTML generation from templates).
+* Additional web features also require ``aiohttp-apispec`` (autogenerated documentation), ``aiohttp_cors`` (CORS support, required by documentation)
+* In addition, ``aiohttp_debugtoolbar`` is required for debug panel. Please note that this option does not work together with authorization and basically must not be used in production.
+* In addition, authorization feature requires ``aiohttp_security``, ``aiohttp_session`` and ``cryptography``.
+* In addition to base authorization dependencies, OAuth2 also requires ``aioauth-client`` library.
+* In addition if you would like to disable authorization for local access (recommended way in order to run the application itself with reporting support), the ``requests-unixsocket`` library is required.
+
+Middlewares
+^^^^^^^^^^^
+
+Service provides some custom middlewares, e.g. logging every exception (except for user ones) and user authorization.
+
+HEAD and OPTIONS requests
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+``HEAD`` request is automatically generated by ``ahriman.web.views.base.BaseView`` class. It just calls ``GET`` method, removes any data from body and returns the result. In case if no ``GET`` method available for this view, the ``aiohttp.web.HTTPMethodNotAllowed`` exception will be raised.
+
+On the other side, ``OPTIONS`` method is implemented in the ``ahriman.web.middlewares.exception_handler.exception_handler`` middleware. In case if ``aiohttp.web.HTTPMethodNotAllowed`` exception is raised and original method was ``OPTIONS``, the middleware handles it, converts to valid request and returns response to user.
+
+Web views
+^^^^^^^^^
+
+All web views are defined in separated package and derived from ``ahriman.web.views.base.Base`` class which provides typed interfaces for web application. 
+
+REST API supports both form and JSON data, but the last one is recommended. 
+
+Different APIs are separated into different packages:
+
+* ``ahriman.web.views.api`` not a real API, but some views which provide OpenAPI support.
+* ``ahriman.web.views.*.service`` provides views for application controls.
+* ``ahriman.web.views.*.status`` package provides REST API for application reporting.
+* ``ahriman.web.views.*.user`` package provides login and logout methods which can be called without authorization.
+
+The views are also divided by supporting API versions (e.g. ``v1``, ``v2``).
+
+Templating
+^^^^^^^^^^
+
+Package provides base jinja templates which can be overridden by settings. Vanilla templates are actively using bootstrap library.
+
+Requests and scopes
+^^^^^^^^^^^^^^^^^^^
+
+Service provides optional authorization which can be turned on in settings. In order to control user access there are two levels of authorization - read-only (only GET-like requests) and write (anything) which are provided by each web view directly.
+
+If this feature is configured any request will be prohibited without authentication. In addition, configuration flag ``auth.allow_read_only`` can be used in order to allow read-only operations - reading index page and packages - without authorization.
+
+For authenticated users it uses encrypted session cookies to store tokens; encryption key is generated each time at the start of the application. It also stores expiration time of the session inside.
+
+External calls
+^^^^^^^^^^^^^^
+
+Web application provides external calls to control main service. It spawns child process with specific arguments and waits for its termination. This feature must be used either with authorization or in safe (i.e. when status page is not available world-wide) environment.
+
+For most actions it also extracts user from authentication (if provided) and passes it to underlying process.

docs/command-line.rst

@@ -0,0 +1,10 @@
+Commands reference
+==================
+
+ahriman
+-------
+
+.. argparse::
+   :module: ahriman.application.ahriman
+   :func: _parser
+   :prog: ahriman

docs/conf.py

@@ -0,0 +1,92 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+
+from pathlib import Path
+
+from ahriman import __version__
+
+
+basedir = Path(__file__).resolve().parent.parent / "src"
+sys.path.insert(0, str(basedir))
+
+on_rtd = os.environ.get("READTHEDOCS", None) == "True"
+
+
+# -- Project information -----------------------------------------------------
+
+project = "ahriman"
+copyright = "2021-2023, ahriman team"
+author = "ahriman team"
+
+# The full version, including alpha/beta/rc tags
+release = __version__
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named "sphinx.ext.*") or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx_rtd_theme",
+    "sphinxarg.ext",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = "en"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = []
+
+add_module_names = False
+
+modindex_common_prefix = ["ahriman.application.", "ahriman.core.", "ahriman.models.", "ahriman.web."]
+
+
+# -- Extension configuration -------------------------------------------------
+
+autoclass_content = "both"
+
+autodoc_member_order = "groupwise"
+
+autodoc_mock_imports = ["cryptography", "pyalpm"]
+
+autodoc_default_options = {
+    "no-undoc-members": True,
+}

docs/configuration.rst

@@ -0,0 +1,355 @@
+Configuration
+=============
+
+Some groups can be specified for each architecture and/or repository separately. E.g. if there are ``build`` and ``build:x86_64`` groups it will use an option from ``build:x86_64`` for the ``x86_64`` architecture and ``build`` for any other (architecture specific group has higher priority). In case if both groups are presented, architecture specific options will be merged into global ones overriding them. The order which will be used for option resolution is the following:
+
+#. Repository and architecture specific, e.g. ``build:aur-clone:x86_64``.
+#. Repository specific, e.g. ``build:aur-clone``.
+#. Architecture specific, e.g. ``build:x86_64``.
+#. Default section, e.g. ``build``.
+
+There are two variable types which have been added to default ones, they are paths and lists. List values will be read in the same way as shell does:
+
+* By default, it splits value by spaces excluding empty elements. 
+* In case if quotation mark (``"`` or ``'``) will be found, any spaces inside will be ignored.
+* In order to use quotation mark inside value it is required to put it to another quotation mark, e.g. ``wor"'"d "with quote"`` will be parsed as ``["wor'd", "with quote"]`` and vice versa.
+* Unclosed quotation mark is not allowed and will rise an exception.
+
+Path values, except for casting to ``pathlib.Path`` type, will be also expanded to absolute paths relative to the configuration path. E.g. if path is set to ``ahriman.ini.d/logging.ini`` and root configuration path is ``/etc/ahriman.ini``, the value will be expanded to ``/etc/ahriman.ini.d/logging.ini``. In order to disable path expand, use the full path, e.g. ``/etc/ahriman.ini.d/logging.ini``.
+
+Configuration allows string interpolation from environment variables, e.g.:
+
+.. code-block:: ini
+
+   [section]
+   key = $SECRET
+
+will try to read value from ``SECRET`` environment variable. In case if the required environment variable wasn't found, it will keep original value (i.e. ``$SECRET`` in the example). Dollar sign can be set as ``$$``.
+
+There is also additional subcommand which will allow to validate configuration and print found errors. In order to do so, run ``service-config-validate`` subcommand, e.g.:
+
+.. code-block:: shell
+
+   ahriman service-config-validate
+
+It will check current settings on common errors and compare configuration with known schema.
+
+``settings`` group
+------------------
+
+Base configuration settings.
+
+* ``apply_migrations`` - perform migrations on application start, boolean, optional, default ``yes``. Useful if you are using git version. Note, however, that this option must be changed only if you know what to do and going to handle migrations automatically.
+* ``database`` - path to SQLite database, string, required.
+* ``include`` - path to directory with configuration files overrides, string, optional.
+* ``logging`` - path to logging configuration, string, required. Check ``logging.ini`` for reference.
+
+``alpm:*`` groups
+-----------------
+
+libalpm and AUR related configuration. Group name can refer to architecture, e.g. ``alpm:x86_64`` can be used for x86_64 architecture specific settings.
+
+* ``database`` - path to pacman system database cache, string, required.
+* ``mirror`` - package database mirror used by pacman for syncronization, string, required. This option supports standard pacman substitutions with ``$arch`` and ``$repo``. Note that the mentioned mirror should contain all repositories which are set by ``alpm.repositories`` option.
+* ``repositories`` - list of pacman repositories, space separated list of strings, required.
+* ``root`` - root for alpm library, string, required.
+* ``use_ahriman_cache`` - use local pacman package cache instead of system one, boolean, required. With this option enabled you might want to refresh database periodically (available as additional flag for some subcommands).
+
+``auth`` group
+--------------
+
+Base authorization settings. ``OAuth`` provider requires ``aioauth-client`` library to be installed.
+
+* ``target`` - specifies authorization provider, string, optional, default ``disabled``. Allowed values are ``disabled``, ``configuration``, ``oauth``.
+* ``allow_read_only`` - allow requesting status APIs without authorization, boolean, required.
+* ``client_id`` - OAuth2 application client ID, string, required in case if ``oauth`` is used.
+* ``client_secret`` - OAuth2 application client secret key, string, required in case if ``oauth`` is used.
+* ``cookie_secret_key`` - secret key which will be used for cookies encryption, string, optional. It must be 32 url-safe base64-encoded bytes and can be generated as following ``base64.urlsafe_b64encode(os.urandom(32)).decode("utf8")``. If not set, it will be generated automatically; note, however, that in this case, all sessions will be automatically expired during restart.
+* ``max_age`` - parameter which controls both cookie expiration and token expiration inside the service, integer, optional, default is 7 days.
+* ``oauth_icon`` - OAuth2 login button icon, string, optional, default is ``google``. Must be valid `Bootstrap icon <https://icons.getbootstrap.com/>`_ name.
+* ``oauth_provider`` - OAuth2 provider class name as is in ``aioauth-client`` (e.g. ``GoogleClient``, ``GithubClient`` etc), string, required in case if ``oauth`` is used.
+* ``oauth_scopes`` - scopes list for OAuth2 provider, which will allow retrieving user email (which is used for checking user permissions), e.g. ``https://www.googleapis.com/auth/userinfo.email`` for ``GoogleClient`` or ``user:email`` for ``GithubClient``, space separated list of strings, required in case if ``oauth`` is used.
+* ``salt`` - additional password hash salt, string, optional.
+
+Authorized users are stored inside internal database, if any of external provides are used the password field for non-service users must be empty. 
+
+``build:*`` groups
+------------------
+
+Build related configuration. Group name can refer to architecture, e.g. ``build:x86_64`` can be used for x86_64 architecture specific settings.
+
+* ``archbuild_flags`` - additional flags passed to ``archbuild`` command, space separated list of strings, optional.
+* ``build_command`` - default build command, string, required.
+* ``ignore_packages`` - list packages to ignore during a regular update (manual update will still work), space separated list of strings, optional.
+* ``makepkg_flags`` - additional flags passed to ``makepkg`` command, space separated list of strings, optional.
+* ``makechrootpkg_flags`` - additional flags passed to ``makechrootpkg`` command, space separated list of strings, optional.
+* ``triggers`` - list of ``ahriman.core.triggers.Trigger`` class implementation (e.g. ``ahriman.core.report.ReportTrigger ahriman.core.upload.UploadTrigger``) which will be loaded and run at the end of processing, space separated list of strings, optional. You can also specify triggers by their paths, e.g. ``/usr/lib/python3.10/site-packages/ahriman/core/report/report.py.ReportTrigger``. Triggers are run in the order of mention.
+* ``triggers_known`` - optional list of ``ahriman.core.triggers.Trigger`` class implementations which are not run automatically and used only for trigger discovery and configuration validation.
+* ``vcs_allowed_age`` - maximal age in seconds of the VCS packages before their version will be updated with its remote source, integer, optional, default ``604800``.
+
+``repository`` group
+--------------------
+
+Base repository settings.
+
+* ``root`` - root path for application, string, required.
+
+``sign:*`` groups
+-----------------
+
+Settings for signing packages or repository. Group name can refer to architecture, e.g. ``sign:x86_64`` can be used for x86_64 architecture specific settings.
+
+* ``target`` - configuration flag to enable signing, space separated list of strings, required. Allowed values are ``package`` (sign each package separately), ``repository`` (sign repository database file).
+* ``key`` - default PGP key, string, required. This key will also be used for database signing if enabled.
+
+``status`` group
+----------------
+
+Reporting to web service related settings. In most cases there is fallback to web section settings.
+
+* ``enabled`` - enable reporting to web service, boolean, optional, default ``yes`` for backward compatibility.
+* ``address`` - remote web service address with protocol, string, optional. In case of websocket, the ``http+unix`` scheme and url encoded address (e.g. ``%2Fvar%2Flib%2Fahriman`` for ``/var/lib/ahriman``) must be used, e.g. ``http+unix://%2Fvar%2Flib%2Fahriman%2Fsocket``. In case if none set, it will be guessed from ``web`` section.
+* ``password`` - password to authorize in web service in order to update service status, string, required in case if authorization enabled.
+* ``suppress_http_log_errors`` - suppress http log errors, boolean, optional, default ``no``. If set to ``yes``, any http log errors (e.g. if web server is not available, but http logging is enabled) will be suppressed.
+* ``username`` - username to authorize in web service in order to update service status, string, required in case if authorization enabled.
+
+``web`` group
+-------------
+
+Web server settings. If any of ``host``/``port`` is not set, web integration will be disabled. This feature requires ``aiohttp`` libraries to be installed.
+
+* ``address`` - optional address in form ``proto://host:port`` (``port`` can be omitted in case of default ``proto`` ports), will be used instead of ``http://{host}:{port}`` in case if set, string, optional. This option is required in case if ``OAuth`` provider is used.
+* ``debug`` - enable debug toolbar, boolean, optional, default ``no``.
+* ``debug_check_host`` - check hosts to access debug toolbar, boolean, optional, default ``no``.
+* ``debug_allowed_hosts`` - allowed hosts to get access to debug toolbar, space separated list of string, optional.
+* ``enable_archive_upload`` - allow to upload packages via HTTP (i.e. call of ``/api/v1/service/upload`` uri), boolean, optional, default ``no``.
+* ``host`` - host to bind, string, optional.
+* ``index_url`` - full url of the repository index page, string, optional.
+* ``max_body_size`` - max body size in bytes to be validated for archive upload, integer, optional. If not set, validation will be disabled.
+* ``port`` - port to bind, integer, optional.
+* ``static_path`` - path to directory with static files, string, required.
+* ``templates`` - path to templates directories, space separated list of strings, required.
+* ``timeout`` - HTTP request timeout in seconds, integer, optional, default is ``30``.
+* ``unix_socket`` - path to the listening unix socket, string, optional. If set, server will create the socket on the specified address which can (and will) be used by application. Note, that unlike usual host/port configuration, unix socket allows to perform requests without authorization.
+* ``unix_socket_unsafe`` - set unsafe (o+w) permissions to unix socket, boolean, optional, default ``yes``. This option is enabled by default, because it is supposed that unix socket is created in safe environment (only web service is supposed to be used in unsafe), but it can be disabled by configuration.
+* ``wait_timeout`` - wait timeout in seconds, maximum amount of time to be waited before lock will be free, integer, optional.
+
+``keyring`` group
+--------------------
+
+Keyring package generator plugin.
+
+* ``target`` - list of generator settings sections, space separated list of strings, required. It must point to valid section name.
+
+Keyring generator plugin
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+* ``type`` - type of the generator, string, optional, must be set to ``keyring-generator`` if exists.
+* ``description`` - keyring package description, string, optional, default is ``repo PGP keyring``, where ``repo`` is the repository name.
+* ``homepage`` - url to homepage location if any, string, optional.
+* ``license`` - list of licenses which are applied to this package, space separated list of strings, optional, default is ``Unlicense``.
+* ``package`` - keyring package name, string, optional, default is ``repo-keyring``, where ``repo`` is the repository name.
+* ``packagers`` - list of packagers keys, space separated list of strings, optional, if not set, the ``key_*`` options from ``sign`` group will be used.
+* ``revoked`` - list of revoked packagers keys, space separated list of strings, optional.
+* ``trusted`` - list of master keys, space separated list of strings, optional, if not set, the ``key`` option from ``sign`` group will be used.
+
+``mirrorlist`` group
+--------------------
+
+Mirrorlist package generator plugin.
+
+* ``target`` - list of generator settings sections, space separated list of strings, required. It must point to valid section name.
+
+Mirrorlist generator plugin
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+* ``type`` - type of the generator, string, optional, must be set to ``mirrorlist-generator`` if exists.
+* ``description`` - mirrorlist package description, string, optional, default is ``repo mirror list for use by pacman``, where ``repo`` is the repository name.
+* ``homepage`` - url to homepage location if any, string, optional.
+* ``license`` - list of licenses which are applied to this package, space separated list of strings, optional, default is ``Unlicense``.
+* ``package`` - mirrorlist package name, string, optional, default is ``repo-mirrorlist``, where ``repo`` is the repository name.
+* ``path`` - absolute path to generated mirrorlist file, string, optional, default is ``/etc/pacman.d/repo-mirrorlist``, where ``repo`` is the repository name.
+* ``servers`` - list of repository mirrors, space separated list of strings, required.
+
+``remote-pull`` group
+---------------------
+
+Remote git source synchronization settings. Unlike ``Upload`` triggers those triggers are used for PKGBUILD synchronization - fetch from remote repository PKGBUILDs before updating process.
+
+It supports authorization; to do so you'd need to prefix the url with authorization part, e.g. ``https://key:token@github.com/arcan1s/ahriman.git``. It is highly recommended to use application tokens instead of your user authorization details. Alternatively, you can use any other option supported by git, e.g.:
+
+* by SSH key: generate SSH key as ``ahriman`` user and put public part of it to the repository keys.
+* by git credentials helper: consult with the `related man page <https://git-scm.com/docs/gitcredentials>`_.
+
+Available options are:
+
+* ``target`` - list of remote pull triggers to be used, space separated list of strings, optional, defaults to ``gitremote``. It must point to valid section (or to section with architecture), e.g. ``gitremote`` must point to either ``gitremote`` or ``gitremote:x86_64`` (the one with architecture has higher priority).
+
+Remote pull trigger
+^^^^^^^^^^^^^^^^^^^
+
+* ``pull_url`` - url of the remote repository from which PKGBUILDs can be pulled before build process, string, required.
+* ``pull_branch`` - branch of the remote repository from which PKGBUILDs can be pulled before build process, string, optional, default is ``master``.
+
+``remote-push`` group
+---------------------
+
+Remote git source synchronization settings. Same as remote pull triggers those triggers are used for PKGBUILD synchronization - push updated PKGBUILDs to the remote repository after build process.
+
+It supports authorization; to do so you'd need to prefix the url with authorization part, e.g. ``https://key:token@github.com/arcan1s/ahriman.git``. It is highly recommended to use application tokens instead of your user authorization details. Alternatively, you can use any other option supported by git, e.g.:
+
+* by SSH key: generate SSH key as ``ahriman`` user and put public part of it to the repository keys.
+* by git credentials helper: consult with the `related man page <https://git-scm.com/docs/gitcredentials>`_.
+
+Available options are:
+
+* ``target`` - list of remote push triggers to be used, space separated list of strings, optional, defaults to ``gitremote``. It must point to valid section (or to section with architecture), e.g. ``gitremote`` must point to either ``gitremote`` or ``gitremote:x86_64`` (the one with architecture has higher priority).
+
+Remote push trigger
+^^^^^^^^^^^^^^^^^^^
+
+* ``commit_email`` - git commit email, string, optional, default is ``ahriman@localhost``.
+* ``commit_user`` - git commit user, string, optional, default is ``ahriman``.
+* ``push_url`` - url of the remote repository to which PKGBUILDs should be pushed after build process, string, required.
+* ``push_branch`` - branch of the remote repository to which PKGBUILDs should be pushed after build process, string, optional, default is ``master``.
+
+``report`` group
+----------------
+
+Report generation settings.
+
+* ``target`` - list of reports to be generated, space separated list of strings, required. It must point to valid section (or to section with architecture), e.g. ``somerandomname`` must point to existing section, ``email`` must point to either ``email`` or ``email:x86_64`` (the one with architecture has higher priority).
+
+Type will be read from several sources:
+
+* In case if ``type`` option set inside the section, it will be used.
+* Otherwise, it will look for type from section name removing architecture name.
+* And finally, it will use section name as type.
+
+``console`` type
+^^^^^^^^^^^^^^^^
+
+Section name must be either ``console`` (plus optional architecture name, e.g. ``console:x86_64``) or random name with ``type`` set.
+
+* ``type`` - type of the report, string, optional, must be set to ``console`` if exists.
+* ``use_utf`` - use utf8 symbols in output if set and ascii otherwise, boolean, optional, default ``yes``.
+
+``email`` type
+^^^^^^^^^^^^^^
+
+Section name must be either ``email`` (plus optional architecture name, e.g. ``email:x86_64``) or random name with ``type`` set.
+
+* ``type`` - type of the report, string, optional, must be set to ``email`` if exists.
+* ``homepage`` - link to homepage, string, optional.
+* ``host`` - SMTP host for sending emails, string, required.
+* ``link_path`` - prefix for HTML links, string, required.
+* ``no_empty_report`` - skip report generation for empty packages list, boolean, optional, default ``yes``.
+* ``password`` - SMTP password to authenticate, string, optional.
+* ``port`` - SMTP port for sending emails, integer, required.
+* ``receivers`` - SMTP receiver addresses, space separated list of strings, required.
+* ``sender`` - SMTP sender address, string, required.
+* ``ssl`` - SSL mode for SMTP connection, one of ``ssl``, ``starttls``, ``disabled``, optional, default ``disabled``.
+* ``template`` - Jinja2 template name, string, required.
+* ``template_full`` - Jinja2 template name for full package description index, string, optional.
+* ``templates`` - path to templates directories, space separated list of strings, required.
+* ``user`` - SMTP user to authenticate, string, optional.
+
+``html`` type
+^^^^^^^^^^^^^
+
+Section name must be either ``html`` (plus optional architecture name, e.g. ``html:x86_64``) or random name with ``type`` set.
+
+* ``type`` - type of the report, string, optional, must be set to ``html`` if exists.
+* ``homepage`` - link to homepage, string, optional.
+* ``link_path`` - prefix for HTML links, string, required.
+* ``path`` - path to html report file, string, required.
+* ``template`` - Jinja2 template name, string, required.
+* ``templates`` - path to templates directories, space separated list of strings, required.
+
+``remote-call`` type
+^^^^^^^^^^^^^^^^^^^^
+
+Section name must be either ``remote-call`` (plus optional architecture name, e.g. ``remote-call:x86_64``) or random name with ``type`` set.
+
+* ``type`` - type of the report, string, optional, must be set to ``remote-call`` if exists.
+* ``aur`` - check for AUR packages updates, boolean, optional, default ``no``.
+* ``local`` - check for local packages updates, boolean, optional, default ``no``.
+* ``manual`` - update manually built packages, boolean, optional, default ``no``.
+* ``wait_timeout`` - maximum amount of time in seconds to be waited before remote process will be terminated, integer, optional, default ``-1``.
+
+``telegram`` type
+^^^^^^^^^^^^^^^^^
+
+Section name must be either ``telegram`` (plus optional architecture name, e.g. ``telegram:x86_64``) or random name with ``type`` set.
+
+* ``type`` - type of the report, string, optional, must be set to ``telegram`` if exists.
+* ``api_key`` - telegram bot API key, string, required. Please refer FAQ about how to create chat and bot
+* ``chat_id`` - telegram chat id, either string with ``@`` or integer value, required.
+* ``homepage`` - link to homepage, string, optional.
+* ``link_path`` - prefix for HTML links, string, required.
+* ``template`` - Jinja2 template name, string, required.
+* ``template_type`` - ``parse_mode`` to be passed to telegram API, one of ``MarkdownV2``, ``HTML``, ``Markdown``, string, optional, default ``HTML``.
+* ``templates`` - path to templates directories, space separated list of strings, required.
+* ``timeout`` - HTTP request timeout in seconds, integer, optional, default is ``30``.
+
+``upload`` group
+----------------
+
+Remote synchronization settings.
+
+* ``target`` - list of synchronizations to be used, space separated list of strings, required. It must point to valid section (or to section with architecture), e.g. ``somerandomname`` must point to existing section, ``github`` must point to one of ``github`` of ``github:x86_64`` (with architecture it has higher priority).
+
+Type will be read from several sources:
+
+* In case if ``type`` option set inside the section, it will be used.
+* Otherwise, it will look for type from section name removing architecture name.
+* And finally, it will use section name as type.
+
+``github`` type
+^^^^^^^^^^^^^^^
+
+This feature requires GitHub key creation (see below). Section name must be either ``github`` (plus optional architecture name, e.g. ``github:x86_64``) or random name with ``type`` set.
+
+* ``type`` - type of the upload, string, optional, must be set to ``github`` if exists.
+* ``owner`` - GitHub repository owner, string, required.
+* ``password`` - created GitHub API key. In order to create it do the following:
+
+  #. Go to `settings page <https://github.com/settings/profile>`_.
+  #. Switch to `developers settings <https://github.com/settings/apps>`_.
+  #. Switch to `personal access tokens <https://github.com/settings/tokens>`_.
+  #. Generate new token. Required scope is ``public_repo`` (or ``repo`` for private repository support).
+
+* ``repository`` - GitHub repository name, string, required. Repository must be created before any action and must have active branch (e.g. with readme).
+* ``timeout`` - HTTP request timeout in seconds, integer, optional, default is ``30``.
+* ``use_full_release_name`` - if set to ``yes``, the release will contain both repository name and architecture, and only architecture otherwise, boolean, optional, default ``no`` (legacy behavior).
+* ``username`` - GitHub authorization user, string, required. Basically the same as ``owner``.
+
+``remote-service`` type
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Section name must be either ``remote-service`` (plus optional architecture name, e.g. ``remote-service:x86_64``) or random name with ``type`` set.
+
+* ``type`` - type of the report, string, optional, must be set to ``remote-service`` if exists.
+* ``timeout`` - HTTP request timeout in seconds, integer, optional, default is ``30``.
+
+``rsync`` type
+^^^^^^^^^^^^^^
+
+Requires ``rsync`` package to be installed. Do not forget to configure ssh for user ``ahriman``. Section name must be either ``rsync`` (plus optional architecture name, e.g. ``rsync:x86_64``) or random name with ``type`` set.
+
+* ``type`` - type of the upload, string, optional, must be set to ``rsync`` if exists.
+* ``command`` - rsync command to run, space separated list of string, required.
+* ``remote`` - remote server to rsync (e.g. ``1.2.3.4:path/to/sync``), string, required.
+
+``s3`` type
+^^^^^^^^^^^
+
+Requires ``boto3`` library to be installed. Section name must be either ``s3`` (plus optional architecture name, e.g. ``s3:x86_64``) or random name with ``type`` set.
+
+* ``type`` - type of the upload, string, optional, must be set to ``s3`` if exists.
+* ``access_key`` - AWS access key ID, string, required.
+* ``bucket`` - bucket name (e.g. ``bucket``), string, required.
+* ``chunk_size`` - chunk size for calculating entity tags, integer, optional, default 8 * 1024 * 1024.
+* ``object_path`` - path prefix for stored objects, string, optional. If none set, the prefix as in repository tree will be used.
+* ``region`` - bucket region (e.g. ``eu-central-1``), string, required.
+* ``secret_key`` - AWS secret access key, string, required.

docs/index.rst

@@ -0,0 +1,41 @@
+Welcome to ahriman's documentation!
+===================================
+
+Wrapper for managing custom repository inspired by `repo-scripts <https://github.com/arcan1s/repo-scripts>`_.
+
+Features
+--------
+
+* Install-configure-forget manager for the very own repository.
+* Multi architecture and repository support.
+* Dependency manager.
+* VCS packages support.
+* Official repository support.
+* Ability to patch AUR packages and even create package from local PKGBUILDs.
+* Various rebuild options with ability to automatically bump package version.
+* Sign support with gpg (repository, package), multiple packagers support.
+* Triggers for repository updates, e.g. synchronization to remote services (rsync, S3 and GitHub) and report generation (email, html, telegram).
+* Repository status interface with optional authorization and control options.
+
+Live demos
+----------
+
+* `Build status page <https://ahriman-demo.arcanis.me>`_. You can login as ``demo`` user by using ``demo`` password. Note, however, you will not be able to run tasks. `HTTP API documentation <https://ahriman-demo.arcanis.me/api-docs>`_ is also available.
+* `Repository index <https://repo.arcanis.me/x86_64/index.html>`_.
+* `Telegram feed <https://t.me/arcanisrepo>`_.
+
+Contents
+--------
+
+.. toctree::
+   :maxdepth: 2
+
+   setup
+   configuration
+   command-line
+   faq
+   migration
+   architecture
+   advanced-usage
+   triggers
+   modules

docs/migration.rst

@@ -0,0 +1,66 @@
+Manual migrations
+=================
+
+Normally the most of migrations are handled automatically after application start, however, some upgrades require manual interventions; this document describes them.
+
+Upgrades to breakpoints
+-----------------------
+
+To 2.9.0
+^^^^^^^^
+
+This release includes major upgrade for the newest devtools and archlinux repository structure. In order to upgrade package need to:
+
+#. Upgrade to the latest major release of python (3.11) (required by other changes).
+#. Upgrade devtools to the latest release.
+#. Backup local settings, ``/etc/ahriman.ini.d/00-setup-overrides.ini`` by default.
+#. Run setup command (i.e. ``ahriman service-setup``) again with the same arguments as used before. This step can be done manually by moving ``devtools`` configuration (something like ``/usr/share/devtools/pacman-ahriman*.conf``) to new location ``/usr/share/devtools/pacman.conf.d/`` under name ``ahriman.conf``. After that make sure to remove any ``community`` mentions from configurations (e.g. ``/usr/share/devtools/pacman.conf.d/ahriman.conf``, ``/etc/ahriman.ini``) if there were any. The only thing which will change is ``devtools`` configuration.
+#. Remove build chroot as it is incompatible, e.g. ``sudo ahriman service-clean --chroot``.
+#. Run ``sudo -u ahriman ahriman update --no-aur --no-local --no-manual -yy`` in order to update local databases.
+
+To 2.12.0
+^^^^^^^^^
+
+This release includes paths migration. Unlike usual case, no automatic migration is performed because it might break user configuration. The following noticeable changes have been made:
+
+* Path to pre-built packages now includes repository name, i.e. it has been changed from ``/var/lib/ahriman/packages/x86_64`` to ``/var/lib/ahriman/packages/aur-clone/x86_64``.
+* Path to pacman databases now includes repository name too, it has been changed from ``/var/lib/ahriman/pacman/x86_64`` to ``/var/lib/ahriman/pacman/aur-clone/x86_64``.
+* Path to repository itself also includes repository name, from ``/var/lib/ahriman/repository/x86_64`` to ``/var/lib/ahriman/repository/aur-clone/x86_64``.
+
+In order to migrate to the new filesystem tree the following actions are required:
+
+#.
+   Stop and disable all services, e.g. timer and web service:
+
+   .. code-block:: shell
+
+      sudo systemctl disable --now ahriman@x86_64.timer
+      sudo systemctl disable --now ahriman-web@x86_64
+
+#.
+   Create directory tree. It can be done by running ``ahriman service-tree-migrate`` subcommand. It performs copying between the old repository tree and the new one. Alternatively directories can be copied by hands.
+
+#.
+   Edit configuration in case if anything is pointing to the old path, e.g. HTML report generation, in the way in which it will point to the directory inside repository specific one, e.g. ``/var/lib/ahriman/repository/x86_64`` to ``/var/lib/ahriman/repository/aur-clone/x86_64``.
+
+#.
+   Run setup command (i.e. ``ahriman service-setup``) again with the same arguments as used before. This step can be done manually by editing devtools pacman configuration (``/usr/share/devtools/pacman.conf.d/ahriman-x86_64.conf`` by default) replacing ``Server`` with path to the repository, e.g.:
+
+   .. code-block:: ini
+
+      [aur-clone]
+      SigLevel = Optional TrustAll
+      Server = file:///var/lib/ahriman/repository/aur-clone/x86_64
+
+   In case of manual interventions make sure to remove architecture reference from ``web`` sections (if any) to avoid ambiguity.
+
+#.
+   Make sure to update remote synchronization services if any. Almost all of them rely on current repository tree by default, so it is required to setup either redirects or configure to synchronize to the old locations (e.g. ``object_path`` option for S3 synchronization).
+
+#.
+   Enable and start services again. Unit template parameter should include both repository architecture and name, dash separated, e.g. ``x86_64-aur-clone``, where ``x86_64`` is the repository architecture and ``aur-clone`` is the repository name:
+
+   .. code-block:: shell
+
+      sudo systemctl enable --now ahriman@x86_64-aur-clone.timer
+      sudo systemctl enable --now ahriman-web

docs/modules.rst

@@ -0,0 +1,7 @@
+Modules
+=======
+
+.. toctree::
+   :maxdepth: 4
+
+   ahriman

docs/setup.rst

@@ -0,0 +1,93 @@
+Initial setup
+=============
+
+#. 
+   Install package as usual.
+#. 
+   Change settings if required, see :doc:`configuration reference <configuration>` for more details.
+#.
+   Perform initial setup:
+
+   .. code-block:: shell
+
+      sudo ahriman -a x86_64 -r aur-clone service-setup ...
+
+   ``service-setup`` literally does the following steps:
+
+   #.
+      Create ``/var/lib/ahriman/.makepkg.conf`` with ``makepkg.conf`` overrides if required (at least you might want to set ``PACKAGER``):
+
+      .. code-block:: shell
+
+          echo 'PACKAGER="John Doe <john@doe.com>"' | sudo -u ahriman tee -a /var/lib/ahriman/.makepkg.conf
+
+   #.
+      Configure build tools (it is required for correct dependency management system):
+
+      #. 
+         Create build command (you can choose any name for command, basically it should be ``{name}-{arch}-build``):
+
+         .. code-block:: shell
+
+            ln -s /usr/bin/archbuild /usr/local/bin/aur-clone-x86_64-build
+
+      #. 
+         Create configuration file (same as previous ``{name}.conf``):
+
+         .. code-block:: shell
+
+            cp /usr/share/devtools/pacman.conf.d/{extra,aur-clone}.conf
+
+      #. 
+         Change configuration file, add your own repository, add multilib repository etc:
+
+         .. code-block:: shell
+
+            echo '[multilib]' | tee -a /usr/share/devtools/pacman.conf.d/aur-clone-x86_64.conf
+            echo 'Include = /etc/pacman.d/mirrorlist' | tee -a /usr/share/devtools/pacman.conf.d/aur-clone-x86_64.conf
+
+            echo '[aur-clone]' | tee -a /usr/share/devtools/pacman.conf.d/aur-clone-x86_64.conf
+            echo 'SigLevel = Optional TrustAll' | tee -a /usr/share/devtools/pacman.conf.d/aur-clone-x86_64.conf
+            echo 'Server = file:///var/lib/ahriman/repository/$repo/$arch' | tee -a /usr/share/devtools/pacman.conf.d/aur-clone-x86_64.conf
+
+      #. 
+         Set ``build_command`` option to point to your command:
+
+         .. code-block:: shell
+
+            echo '[build]' | tee -a /etc/ahriman.ini.d/build.ini
+            echo 'build_command = aur-clone-x86_64-build' | tee -a /etc/ahriman.ini.d/build.ini
+
+      #.
+         Configure ``/etc/sudoers.d/ahriman`` to allow running command without a password:
+
+         .. code-block:: shell
+
+            echo 'Cmnd_Alias CARCHBUILD_CMD = /usr/local/bin/aur-clone-x86_64-build *' | tee -a /etc/sudoers.d/ahriman
+            echo 'ahriman ALL=(ALL) NOPASSWD:SETENV: CARCHBUILD_CMD' | tee -a /etc/sudoers.d/ahriman
+            chmod 400 /etc/sudoers.d/ahriman
+
+      This command supports several arguments, kindly refer to its help message.
+
+#. 
+   Start and enable ``ahriman@.timer`` via ``systemctl``:
+
+   .. code-block:: shell
+
+       systemctl enable --now ahriman@x86_64-aur-clone.timer
+
+#. 
+   Start and enable status page:
+
+   .. code-block:: shell
+
+       systemctl enable --now ahriman-web
+
+#. 
+   Add packages by using ``ahriman package-add {package}`` command:
+
+   .. code-block:: shell
+
+       sudo -u ahriman ahriman package-add ahriman --now --refresh
+
+   The ``--refresh`` flag is required in order to handle local database update.

docs/triggers.rst

@@ -0,0 +1,142 @@
+Triggers
+========
+
+The package provides ability to write custom extensions which will be run on (the most) actions, e.g. after updates. By default ahriman provides three types of extensions - reporting, files uploading and PKGBUILD syncronization. Each extension must derive from the ``ahriman.core.triggers.Trigger`` class and should implement at least one of the abstract methods:
+
+* ``on_result`` - trigger action which will be called after build process, the build result and the list of repository packages will be supplied as arguments.
+* ``on_start`` - trigger action which will be called right before the start of the application process.
+* ``on_stop`` - action which will be called right before the exit.
+
+Note, it isn't required to implement all of those methods (or even one of them), however, it is highly recommended to avoid trigger actions in ``__init__`` method as it will be run on any application start (e.g. even if you are just searching in AUR).
+
+Built-in triggers
+-----------------
+
+For the configuration details and settings explanation kindly refer to the :doc:`documentation <configuration>`.
+
+``ahriman.core.gitremote.RemotePullTrigger``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This trigger will be called before any action (``on_start``) and pulls remote PKGBUILD repository locally; after that it copies found PKGBUILDs from the cloned repository to the local cache. It is useful in case if you have patched PGKBUILDs (or even missing in AUR) which you would like to use for package building and, technically, just simplifies the local package building.
+
+In order to update those packages you would need to clone your repository separately, make changes in PKGBUILD (e.g. bump version and update checksums), commit them and push back. On the next ahriman's repository update, it will pull changes you committed and will perform package update.
+
+``ahriman.core.gitremote.RemotePushTrigger``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This trigger will be called right after build process (``on_result``). It will pick PKGBUILDs for the updated packages, pull them (together with any other files) and commit and push changes to remote repository. No real use cases, but the most of user repositories do it.
+
+``ahriman.core.report.ReportTrigger``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Trigger which can be used for reporting. It implements ``on_result`` method and thus being called on each build update and generates report (e.g. html, telegram etc) according to the current settings.
+
+``ahriman.core.support.KeyringTrigger``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Generator for keyring package. This trigger will extract keys from local keychain and pack them into keyring specific format. This trigger will generate sources including PKGBUILD, which can be used later for package building.
+
+``ahriman.core.support.MirrorlistTrigger``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Simple generator for mirrorlist package, based on the urls which were set by configuration. This trigger will generate sources including PKGBUILD, which can be used later for package building.
+
+``ahriman.core.upload.UploadTrigger``
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This trigger takes build result (``on_result``) and performs syncing of the local packages to the remote mirror (e.g. S3 or just by rsync).
+
+Context variables
+-----------------
+
+By default, only configuration and architecture are passed to triggers. However, some triggers might want to have access to other high-level wrappers. In order to provide such ability and avoid (double) initialization, the service provides a global context variables, which can be accessed from ``ahriman.core`` package:
+
+.. code-block:: python
+
+   from ahriman.core import context
+
+   ctx = context.get()
+
+Just because context is wrapped inside ``contexvars.ContextVar``, you need to explicitly extract variable by ``get()`` method. Later you can extract any variable if it is set, e.g.:
+
+.. code-block:: python
+
+   from ahriman.core.database import SQLite
+   from ahriman.models.context_key import ContextKey
+
+   database = ctx.get(ContextKey("database", SQLite))
+
+In order to provide typed API, all variables are stored together with their type. The ``get(ContextKey)`` method will throw ``KeyError`` in case if key is missing. Alternatively you can set your own variable inside context:
+
+.. code-block:: python
+
+   ctx.set(ContextKey("answer", int), 42)
+   context.set(ctx)
+
+Note, however, that there are several limitations:
+
+* Context variables are immutable, thus you cannot override value if the key already presented.
+* The ``return_type`` of ``ContextKey`` should match the value type, otherwise exception will be thrown.
+
+The ``context`` also implements collection methods such as ``__iter__`` and ``__len__``.
+
+Trigger example
+---------------
+
+Lets consider example of reporting trigger (e.g. `slack <https://slack.com/>`_, which provides easy HTTP API for integration triggers).
+
+In order to post message to slack we will need a specific trigger url (something like ``https://hooks.slack.com/services/company_id/trigger_id``), channel (e.g. ``#archrepo``) and username (``repo-bot``).
+
+As it has been mentioned, our trigger must derive from specific class:
+
+.. code-block:: python
+
+   from ahriman.core.triggers import Trigger
+
+   class SlackReporter(Trigger):
+
+       def __init__(self, repository_id, configuration):
+           Trigger.__init__(self, repository_id, configuration)
+           self.slack_url = configuration.get("slack", "url")
+           self.channel = configuration.get("slack", "channel")
+           self.username = configuration.get("slack", "username")
+
+By now we have class with all required variables. Lets implement run method. Slack API requires positing data with specific payload by HTTP, thus:
+
+.. code-block:: python
+
+   import json
+   import requests
+
+   def notify(result, slack_url, channel, username):
+       text = f"""Build has been completed with packages: {", ".join([package.name for package in result.success])}"""
+       payload = {"channel": channel, "username": username, "text": text}
+       response = requests.post(slack_url, data={"payload": json.dumps(payload)})
+       response.raise_for_status()
+
+Obviously you can implement the specified method in class, but for guide purpose it has been done as separated method. Now we can merge this method into the class:
+
+.. code-block:: python
+
+   class SlackReporter(Trigger):
+
+       def __init__(self, repository_id, configuration):
+           Trigger.__init__(self, repository_id, configuration)
+           self.slack_url = configuration.get("slack", "url")
+           self.channel = configuration.get("slack", "channel")
+           self.username = configuration.get("slack", "username")
+
+       def on_result(self, result, packages):
+           notify(result, self.slack_url, self.channel, self.username)
+
+Setup the trigger
+^^^^^^^^^^^^^^^^^
+
+First, put the trigger in any path it can be exported, e.g. by packing the resource into python package (which will lead to import path as ``package.slack_reporter.SlackReporter``) or just put file somewhere it can be accessed by application (e.g. ``/usr/local/lib/slack_reporter.SlackReporter``).
+
+After that run application as usual and receive notification in your slack channel.
+
+Trigger configuration schema
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Triggers can expose their configuration schema. It can be achieved by implementing ``CONFIGURATION_SCHEMA`` class variable according to `cerberus <https://docs.python-cerberus.org/>`_ documentation. For more details and examples, please refer to built-in triggers implementations.

package/archlinux/PKGBUILD

@@ -1,45 +1,61 @@
 # Maintainer: Evgeniy Alekseev
 
 pkgname='ahriman'
-pkgver=0.15.0
+pkgver=2.12.2
 pkgrel=1
-pkgdesc="ArcHlinux ReposItory MANager"
+pkgdesc="ArcH linux ReposItory MANager"
 arch=('any')
 url="https://github.com/arcan1s/ahriman"
 license=('GPL3')
-depends=('devtools' 'git' 'pyalpm' 'python-aur' 'python-srcinfo')
+depends=('devtools>=1:1.0.0' 'git' 'pyalpm' 'python-cerberus' 'python-inflection' 'python-passlib' 'python-requests' 'python-srcinfo')
-makedepends=('python-pip')
+makedepends=('python-build' 'python-flit' 'python-installer' 'python-wheel')
-optdepends=('aws-cli: sync to s3'
+optdepends=('breezy: -bzr packages support'
-            'breezy: -bzr packages support'
             'darcs: -darcs packages support'
-            'gnupg: package and repository sign'
             'mercurial: -hg packages support'
+            'python-aioauth-client: web server with OAuth2 authorization'
             'python-aiohttp: web server'
+            'python-aiohttp-apispec>=3.0.0: web server'
+            'python-aiohttp-cors: web server'
+            'python-aiohttp-debugtoolbar: web server with enabled debug panel'
             'python-aiohttp-jinja2: web server'
+            'python-aiohttp-security: web server with authorization'
+            'python-aiohttp-session: web server with authorization'
+            'python-boto3: sync to s3'
+            'python-cryptography: web server with authorization'
+            'python-requests-unixsocket: client report to web server by unix socket'
             'python-jinja: html report generation'
-            'python-requests: web server'
+            'python-systemd: journal support'
             'rsync: sync by using rsync'
             'subversion: -svn packages support')
 source=("https://github.com/arcan1s/ahriman/releases/download/$pkgver/$pkgname-$pkgver-src.tar.xz"
         'ahriman.sysusers'
         'ahriman.tmpfiles')
-sha512sums=('a1db44390ce1785da3d535e3cfd2242d8d56070228eb9b3c1d5629163b65941d60753c481c0fdc69e475e534a828ceea39568dc6711abeee092616dac08e31a9'
+install="$pkgname.install"
-            '13718afec2c6786a18f0b223ef8e58dccf0688bca4cdbe203f14071f5031ed20120eb0ce38b52c76cfd6e8b6581a9c9eaa2743eb11abbaca637451a84c33f075'
-            '55b20f6da3d66e7bbf2add5d95a3b60632df121717d25a993e56e737d14f51fe063eb6f1b38bd81cc32e05db01c0c1d80aaa720c45cde87f238d8b46cdb8cbc4')
 backup=('etc/ahriman.ini'
         'etc/ahriman.ini.d/logging.ini')
 
 build() {
   cd "$pkgname"
 
-  python setup.py build
+  python -m build --wheel --no-isolation
 }
 
 package() {
   cd "$pkgname"
 
-  python setup.py install --root="$pkgdir"
+  python -m installer --destdir="$pkgdir" "dist/$pkgname-$pkgver-py3-none-any.whl"
+
+  # thanks too PEP517, which we all wanted, you need to install data files manually nowadays
+  pushd package && find . \( -type f -or -type l \) -exec install -Dm644 "{}" "$pkgdir/usr/{}" \; && popd
+
+  # keep usr/share configs as reference and copy them to /etc
+  install -Dm644 "$pkgdir/usr/share/$pkgname/settings/ahriman.ini" "$pkgdir/etc/ahriman.ini"
+  install -Dm644 "$pkgdir/usr/share/$pkgname/settings/ahriman.ini.d/logging.ini" "$pkgdir/etc/ahriman.ini.d/logging.ini"
 
   install -Dm644 "$srcdir/$pkgname.sysusers" "$pkgdir/usr/lib/sysusers.d/$pkgname.conf"
   install -Dm644 "$srcdir/$pkgname.tmpfiles" "$pkgdir/usr/lib/tmpfiles.d/$pkgname.conf"
 }
+
+sha512sums=('19841842641520b573cdde6cb80a7cfcd69756d323fdfeebc2eee2d264a1325ead4ab2f8383bb369f7896bfc1de59d7358f133f4afeb90a9b9f0695f482a58d0'
+            '53d37efec812afebf86281716259f9ea78a307b83897166c72777251c3eebcb587ecee375d907514781fb2a5c808cbb24ef9f3f244f12740155d0603bf213131'
+            '62b2eccc352d33853ef243c9cddd63663014aa97b87242f1b5bc5099a7dbd69ff3821f24ffc58e1b7f2387bd4e9e9712cc4c67f661b1724ad99cdf09b3717794')

package/archlinux/ahriman.install

@@ -0,0 +1,42 @@
+post_upgrade() {
+    local breakpoints=(
+        2.9.0-1
+        2.12.0-1
+    )
+
+    for v in "${breakpoints[@]}"; do
+        if [[ $(vercmp "$v" "$2") -ne "-1" ]]; then
+            "_${v//[.-]/_}_changes"
+        fi
+    done
+}
+
+_2_9_0_1_changes() {
+    cat << EOF
+It was found that there was an upgrade from old devtools package to the new one, which requires manual intervention:
+
+* make sure that devtools are upgraded to the latest release;
+* merge upstream configuration into local configuration (e.g. by using pacdiff);
+* run setup command (i.e. ahriman service-setup) with the same arguments as did before;
+* remove build chroot, e.g.: ahriman service-clean --chroot;
+* update local databases: ahriman update --no-aur --no-local --no-manual -yy.
+
+For more information kindly refer to migration notes https://ahriman.readthedocs.io/en/stable/migration.html.
+EOF
+}
+
+_2_12_0_1_changes() {
+    cat << EOF
+Whereas old local tree is still supported it is highly recommended to migrate to the new one:
+
+* stop and disable all services;
+* run service-tree-migrate as ahriman user;
+* edit local configuration to avoid pointing to the old paths;
+* run setup command (i.e. ahriman service-setup) with the same arguments as did before;
+* update remote services in order to support new paths (or setup redirects) if any;
+* enable web and timer services again by using x86_64-aur-clone suffix,
+  where x86_64 is the repository architecture and aur-clone is the repository name.
+
+For more information kindly refer to migration notes https://ahriman.readthedocs.io/en/stable/migration.html.
+EOF
+}

package/archlinux/ahriman.sysusers

@@ -1 +1 @@
-u ahriman 643 "ArcHlinux ReposItory MANager" /var/lib/ahriman
+u ahriman 643 "ArcH linux ReposItory MANager" /var/lib/ahriman

package/archlinux/ahriman.tmpfiles

@@ -1,2 +1 @@
-d /var/lib/ahriman 0775 ahriman log
+d /var/lib/ahriman 0755 ahriman ahriman
-d /var/log/ahriman 0755 ahriman ahriman

package/bin/ahriman

@@ -1,3 +0,0 @@
-#!/bin/sh
-
-exec python -B -m ahriman.application.ahriman "$@"

package/etc/ahriman.ini

@@ -1,47 +0,0 @@
-[settings]
-include = /etc/ahriman.ini.d
-logging = /etc/ahriman.ini.d/logging.ini
-
-[alpm]
-aur_url = https://aur.archlinux.org
-database = /var/lib/pacman
-repositories = core extra community multilib
-root = /
-
-[build]
-archbuild_flags =
-build_command = extra-x86_64-build
-ignore_packages =
-makechrootpkg_flags =
-makepkg_flags = --skippgpcheck
-
-[repository]
-name = aur-clone
-root = /var/lib/ahriman
-
-[sign]
-target =
-key =
-
-[report]
-target =
-
-[html]
-path =
-homepage =
-link_path =
-template_path = /usr/share/ahriman/repo-index.jinja2
-
-[upload]
-target =
-
-[rsync]
-remote =
-
-[s3]
-bucket =
-
-[web]
-host =
-port =
-templates = /usr/share/ahriman

package/etc/ahriman.ini.d/logging.ini

@@ -1,59 +0,0 @@
-[loggers]
-keys = root,builder,build_details,http
-
-[handlers]
-keys = console_handler,build_file_handler,file_handler,http_handler
-
-[formatters]
-keys = generic_format
-
-[handler_console_handler]
-class = StreamHandler
-level = DEBUG
-formatter = generic_format
-args = (sys.stderr,)
-
-[handler_file_handler]
-class = logging.handlers.RotatingFileHandler
-level = DEBUG
-formatter = generic_format
-args = ('/var/log/ahriman/ahriman.log', 'a', 20971520, 20)
-
-[handler_build_file_handler]
-class = logging.handlers.RotatingFileHandler
-level = DEBUG
-formatter = generic_format
-args = ('/var/log/ahriman/build.log', 'a', 20971520, 20)
-
-[handler_http_handler]
-class = logging.handlers.RotatingFileHandler
-level = DEBUG
-formatter = generic_format
-args = ('/var/log/ahriman/http.log', 'a', 20971520, 20)
-
-[formatter_generic_format]
-format = [%(levelname)s %(asctime)s] [%(filename)s:%(lineno)d] [%(funcName)s]: %(message)s
-datefmt =
-
-[logger_root]
-level = DEBUG
-handlers = file_handler
-qualname = root
-
-[logger_builder]
-level = DEBUG
-handlers = file_handler
-qualname = builder
-propagate = 0
-
-[logger_build_details]
-level = DEBUG
-handlers = build_file_handler
-qualname = build_details
-propagate = 0
-
-[logger_http]
-level = DEBUG
-handlers = http_handler
-qualname = http
-propagate = 0

package/lib/systemd/system/ahriman-web.service

@@ -0,0 +1,12 @@
+[Unit]
+Description=ArcH linux ReposItory MANager web server
+After=network.target
+
+[Service]
+Type=simple
+ExecStart=/usr/bin/ahriman web
+User=ahriman
+Group=ahriman
+
+[Install]
+WantedBy=multi-user.target

package/lib/systemd/system/ahriman-web@.service

@@ -1,15 +0,0 @@
-[Unit]
-Description=ArcHlinux ReposItory MANager web server (%I architecture)
-After=network.target
-
-[Service]
-Type=simple
-ExecStart=/usr/bin/ahriman --architecture %i web
-User=ahriman
-Group=ahriman
-
-KillSignal=SIGQUIT
-SuccessExitStatus=SIGQUIT
-
-[Install]
-WantedBy=multi-user.target

package/lib/systemd/system/ahriman-web@.service

@@ -0,0 +1 @@
+ahriman-web.service

package/lib/systemd/system/ahriman@.service

@@ -1,7 +1,7 @@
 [Unit]
-Description=ArcHlinux ReposItory MANager (%I architecture)
+Description=ArcH linux ReposItory MANager (%i)
 
 [Service]
-ExecStart=/usr/bin/ahriman --architecture %i update
+ExecStart=/usr/bin/ahriman --repository-id "%I" repo-update --refresh
 User=ahriman
 Group=ahriman

package/lib/systemd/system/ahriman@.timer

@@ -1,5 +1,5 @@
 [Unit]
-Description=ArcHlinux ReposItory MANager timer (%I architecture)
+Description=ArcH linux ReposItory MANager timer (%i)
 
 [Timer]
 OnCalendar=daily

package/share/ahriman/build-status.jinja2

@@ -1,54 +0,0 @@
-<!doctype html>
-<html lang="en">
-    <head>
-        <title>{{ repository|e }}</title>
-
-        {% include "style.jinja2" %}
-
-        {% include "sorttable.jinja2" %}
-        {% include "search.jinja2" %}
-    </head>
-
-    <body>
-        <div class="root">
-            <h1>ahriman
-                <img src="https://img.shields.io/badge/version-{{ version|e }}-informational" alt="{{ version|e }}">
-                <img src="https://img.shields.io/badge/architecture-{{ architecture|e }}-informational" alt="{{ architecture|e }}">
-                <img src="https://img.shields.io/badge/service%20status-{{ service.status|e }}-{{ service.status_color|e }}" alt="{{ service.status|e }}" title="{{ service.timestamp|e }}">
-            </h1>
-
-            {% include "search-line.jinja2" %}
-
-            <section class="element">
-                <table class="sortable search-table">
-                    <tr class="header">
-                        <th>package base</th>
-                        <th>packages</th>
-                        <th>version</th>
-                        <th>last update</th>
-                        <th>status</th>
-                    </tr>
-
-                    {% for package in packages %}
-                        <tr class="package">
-                            <td class="include-search"><a href="{{ package.web_url|e }}" title="{{ package.base|e }}">{{ package.base|e }}</a></td>
-                            <td class="include-search">{{ package.packages|join("<br>"|safe) }}</td>
-                            <td>{{ package.version|e }}</td>
-                            <td>{{ package.timestamp|e }}</td>
-                            <td class="status package-{{ package.status|e }}">{{ package.status|e }}</td>
-                        </tr>
-                    {% endfor %}
-                </table>
-            </section>
-
-            <footer>
-                <ul class="navigation">
-                    <li><a href="https://github.com/arcan1s/ahriman" title="sources">ahriman</a></li>
-                    <li><a href="https://github.com/arcan1s/ahriman/releases" title="releases list">releases</a></li>
-                    <li><a href="https://github.com/arcan1s/ahriman/issues" title="issues tracker">report a bug</a></li>
-                </ul>
-            </footer>
-        </div>
-    </body>
-
-</html>

package/share/ahriman/repo-index.jinja2

@@ -1,62 +0,0 @@
-<!doctype html>
-<html lang="en">
-    <head>
-        <title>{{ repository|e }}</title>
-
-        {% include "style.jinja2" %}
-
-        {% include "sorttable.jinja2" %}
-        {% include "search.jinja2" %}
-    </head>
-
-    <body>
-        <div class="root">
-            <h1>Archlinux user repository</h1>
-
-            <section class="element">
-                {% if pgp_key is not none %}
-                    <p>This repository is signed with <a href="http://keys.gnupg.net/pks/lookup?search=0x{{ pgp_key|e }}&fingerprint=on&op=index" title="key search">{{ pgp_key|e }}</a> by default.</p>
-                {% endif %}
-
-                <code>
-                    $ cat /etc/pacman.conf<br>
-                    [{{ repository|e }}]<br>
-                    Server = {{ link_path|e }}<br>
-                    SigLevel = Database{% if has_repo_signed %}Required{% else %}Never{% endif %} Package{% if has_package_signed %}Required{% else %}Never{% endif %} TrustedOnly
-                </code>
-            </section>
-
-            {% include "search-line.jinja2" %}
-
-            <section class="element">
-                <table class="sortable search-table">
-                    <tr class="header">
-                        <th>package</th>
-                        <th>version</th>
-                        <th>archive size</th>
-                        <th>installed size</th>
-                        <th>build date</th>
-                    </tr>
-
-                    {% for package in packages %}
-                        <tr class="package">
-                            <td class="include-search"><a href="{{ link_path|e }}/{{ package.filename|e }}" title="{{ package.name|e }}">{{ package.name|e }}</a></td>
-                            <td>{{ package.version|e }}</td>
-                            <td>{{ package.archive_size|e }}</td>
-                            <td>{{ package.installed_size|e }}</td>
-                            <td>{{ package.build_date|e }}</td>
-                        </tr>
-                    {% endfor %}
-                </table>
-            </section>
-
-            <footer>
-                <ul class="navigation">
-                    {% if homepage is not none %}
-                        <li><a href="{{ homepage|e }}" title="homepage">Homepage</a></li>
-                    {% endif %}
-                </ul>
-            </footer>
-        </div>
-    </body>
-</html>

package/share/ahriman/search-line.jinja2

@@ -1,3 +0,0 @@
-<section class="element">
-    <input type="search" id="search" onkeyup="searchInTable()" placeholder="search for package" title="search for package"/>
-</section>

package/share/ahriman/search.jinja2

@@ -1,25 +0,0 @@
-<script type="text/javascript">
-    function searchInTable() {
-        const input = document.getElementById("search");
-        const filter = input.value.toLowerCase();
-        const tables = document.getElementsByClassName("search-table");
-
-        for (let i = 0; i < tables.length; i++) {
-            const tr = tables[i].getElementsByTagName("tr");
-            // from 1 coz of header
-            for (let i = 1; i < tr.length; i++) {
-                let td = tr[i].getElementsByClassName("include-search");
-                let display = "none";
-                for (let j = 0; j < td.length; j++) {
-                    if (td[j].tagName.toLowerCase() === "td") {
-                        if (td[j].innerHTML.toLowerCase().indexOf(filter) > -1) {
-                            display = "";
-                            break;
-                        }
-                    }
-                }
-                tr[i].style.display = display;
-            }
-        }
-    }
-</script>

package/share/ahriman/settings/ahriman.ini

@@ -0,0 +1,88 @@
+[settings]
+include = ahriman.ini.d
+logging = ahriman.ini.d/logging.ini
+apply_migrations = yes
+database = /var/lib/ahriman/ahriman.db
+
+[alpm]
+database = /var/lib/pacman
+mirror = https://geo.mirror.pkgbuild.com/$repo/os/$arch
+repositories = core extra multilib
+root = /
+use_ahriman_cache = yes
+
+[auth]
+target = disabled
+max_age = 604800
+oauth_provider = GoogleClient
+oauth_scopes = https://www.googleapis.com/auth/userinfo.email
+allow_read_only = yes
+
+[build]
+archbuild_flags =
+ignore_packages =
+makechrootpkg_flags =
+makepkg_flags = --nocolor --ignorearch
+triggers = ahriman.core.gitremote.RemotePullTrigger ahriman.core.report.ReportTrigger ahriman.core.upload.UploadTrigger ahriman.core.gitremote.RemotePushTrigger
+triggers_known = ahriman.core.gitremote.RemotePullTrigger ahriman.core.gitremote.RemotePushTrigger ahriman.core.report.ReportTrigger ahriman.core.upload.UploadTrigger ahriman.core.support.KeyringTrigger ahriman.core.support.MirrorlistTrigger
+vcs_allowed_age = 604800
+
+[repository]
+root = /var/lib/ahriman
+
+[sign]
+target =
+
+[keyring]
+target =
+
+[mirrorlist]
+target =
+
+[remote-pull]
+target =
+
+[remote-push]
+target =
+
+[report]
+target = console
+
+[console]
+use_utf = yes
+
+[email]
+no_empty_report = yes
+template = email-index.jinja2
+templates = /usr/share/ahriman/templates
+ssl = disabled
+
+[html]
+template = repo-index.jinja2
+templates = /usr/share/ahriman/templates
+
+[status]
+enabled = yes
+suppress_http_log_errors = yes
+
+[telegram]
+template = telegram-index.jinja2
+templates = /usr/share/ahriman/templates
+
+[upload]
+target =
+
+[rsync]
+command = rsync --archive --compress --partial --delete
+
+[s3]
+chunk_size = 8388608
+
+[web]
+debug = no
+debug_check_host = no
+debug_allowed_hosts =
+host = 127.0.0.1
+static_path = /usr/share/ahriman/templates/static
+templates = /usr/share/ahriman/templates
+unix_socket_unsafe = yes

package/share/ahriman/settings/ahriman.ini.d/logging.ini

@@ -0,0 +1,66 @@
+[loggers]
+keys = root,http,stderr,boto3,botocore,nose,s3transfer
+
+[handlers]
+keys = console_handler,journald_handler,syslog_handler
+
+[formatters]
+keys = generic_format,syslog_format
+
+[handler_console_handler]
+class = logging.StreamHandler
+level = DEBUG
+formatter = generic_format
+args = (sys.stderr,)
+
+[handler_journald_handler]
+class = ahriman.core.log.journal_handler.JournalHandler
+level = DEBUG
+formatter = syslog_format
+kwargs = {"SYSLOG_IDENTIFIER": "ahriman"}
+
+[handler_syslog_handler]
+class = logging.handlers.SysLogHandler
+level = DEBUG
+formatter = syslog_format
+args = ("/dev/log",)
+
+[formatter_generic_format]
+format = [%(levelname)s %(asctime)s] [%(name)s]: %(message)s
+
+[formatter_syslog_format]
+format = [%(levelname)s] [%(name)s]: %(message)s
+
+[logger_root]
+level = DEBUG
+qualname = root
+
+[logger_http]
+level = DEBUG
+qualname = http
+propagate = 0
+
+[logger_stderr]
+level = DEBUG
+handlers = console_handler
+qualname = stderr
+
+[logger_boto3]
+level = INFO
+qualname = boto3
+propagate = 0
+
+[logger_botocore]
+level = INFO
+qualname = botocore
+propagate = 0
+
+[logger_nose]
+level = INFO
+qualname = nose
+propagate = 0
+
+[logger_s3transfer]
+level = INFO
+qualname = s3transfer
+propagate = 0

package/share/ahriman/sorttable.jinja2

@@ -1 +0,0 @@
-<script src="https://www.kryogenix.org/code/browser/sorttable/sorttable.js"></script>

package/share/ahriman/style.jinja2

@@ -1,136 +0,0 @@
-<style>
-    :root {
-        --color-building: 255, 255, 146;
-        --color-failed: 255, 94, 94;
-        --color-pending: 255, 255, 146;
-        --color-success: 94, 255, 94;
-        --color-unknown: 225, 225, 225;
-
-        --color-header: 200, 200, 255;
-        --color-hover: 255, 255, 225;
-        --color-line-blue: 235, 235, 255;
-        --color-line-white: 255, 255, 255;
-    }
-
-    @keyframes blink-building {
-        0% { background-color: rgba(var(--color-building), 1.0); }
-        10% { background-color: rgba(var(--color-building), 0.9); }
-        20% { background-color: rgba(var(--color-building), 0.8); }
-        30% { background-color: rgba(var(--color-building), 0.7); }
-        40% { background-color: rgba(var(--color-building), 0.6); }
-        50% { background-color: rgba(var(--color-building), 0.5); }
-        60% { background-color: rgba(var(--color-building), 0.4); }
-        70% { background-color: rgba(var(--color-building), 0.3); }
-        80% { background-color: rgba(var(--color-building), 0.2); }
-        90% { background-color: rgba(var(--color-building), 0.1); }
-        100% { background-color: rgba(var(--color-building), 0.0); }
-    }
-
-    div.root {
-        width: 70%;
-        padding: 15px 15% 0;
-    }
-
-    section.element, footer {
-        width: 100%;
-        padding: 10px 0;
-    }
-
-    code, input, table {
-        width: inherit;
-    }
-
-    th, td {
-        padding: 5px;
-    }
-
-    tr.package:nth-child(odd) {
-        background-color: rgba(var(--color-line-white), 1.0);
-    }
-
-    tr.package:nth-child(even) {
-        background-color: rgba(var(--color-line-blue), 1.0);
-    }
-
-    tr.package:hover {
-        background-color: rgba(var(--color-hover), 1.0);
-    }
-
-    tr.header{
-        background-color: rgba(var(--color-header), 1.0);
-    }
-
-    td.status {
-        text-align: center;
-    }
-
-    td.package-unknown {
-        background-color: rgba(var(--color-unknown), 1.0);
-    }
-    td.package-pending {
-        background-color: rgba(var(--color-pending), 1.0);
-    }
-    td.package-building {
-        background-color: rgba(var(--color-building), 1.0);
-        animation-name: blink-building;
-        animation-duration: 1s;
-        animation-timing-function: linear;
-        animation-iteration-count: infinite;
-        animation-direction: alternate;
-    }
-    td.package-failed {
-        background-color: rgba(var(--color-failed), 1.0);
-    }
-    td.package-success {
-        background-color: rgba(var(--color-success), 1.0);
-    }
-
-    li.service-unknown {
-        background-color: rgba(var(--color-unknown), 1.0);
-    }
-    li.service-building {
-        background-color: rgba(var(--color-building), 1.0);
-        animation-name: blink-building;
-        animation-duration: 1s;
-        animation-timing-function: linear;
-        animation-iteration-count: infinite;
-        animation-direction: alternate;
-    }
-    li.service-failed {
-        background-color: rgba(var(--color-failed), 1.0);
-    }
-    li.service-success {
-        background-color: rgba(var(--color-success), 1.0);
-    }
-
-    ul.navigation {
-        list-style-type: none;
-        margin: 0;
-        padding: 0;
-        overflow: hidden;
-        background-color: rgba(var(--color-header), 1.0);
-    }
-
-    ul.navigation li {
-        float: left;
-    }
-
-    ul.navigation li.status {
-        display: block;
-        text-align: center;
-        text-decoration: none;
-        padding: 14px 16px;
-    }
-
-    ul.navigation li a {
-        display: block;
-        color: black;
-        text-align: center;
-        text-decoration: none;
-        padding: 14px 16px;
-    }
-
-    ul.navigation li a:hover {
-        background-color: rgba(var(--color-hover), 1.0);
-    }
-</style>

package/share/ahriman/templates/api.jinja2

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>ahriman API</title>
+
+    <meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+    <!-- Embed elements Elements via Web Component -->
+    <script src="https://cdn.jsdelivr.net/npm/@stoplight/elements@7.13.7/web-components.min.js" integrity="sha384-aKMPitODat9Dqj3Mva9Rs9jS5Z3KPSW0sFlAOazuULJMFYhAfmORI5SlH9aWIst8" crossorigin="anonymous" type="application/javascript"></script>
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@stoplight/elements@7.13.7/styles.min.css" integrity="sha384-wPzTs1aFAoGq9gqp9NAs2YVTkFXcU2d6Bx11aKRFhVw2B7o1bCwaV9pGHTlUfD2+" crossorigin="anonymous" type="text/css">
+</head>
+<body>
+
+    <elements-api
+            apiDescriptionUrl="/api-docs/swagger.json"
+            router="hash"
+            layout="sidebar"
+    />
+
+</body>
+</html>

package/share/ahriman/templates/build-status.jinja2

@@ -0,0 +1,163 @@
+<!doctype html>
+<html lang="en">
+    <head>
+        <title>ahriman</title>
+
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+
+        {% include "utils/style.jinja2" %}
+        {% include "user-style.jinja2" ignore missing %}
+    </head>
+
+    <body>
+
+        {% include "utils/bootstrap-scripts.jinja2" %}
+
+        <div class="container">
+            <nav class="navbar navbar-expand-lg">
+                <div class="navbar-brand"><img src="/static/logo.svg" width="30" height="30" alt=""> ahriman</div>
+                <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#repositories-navbar-supported-content" aria-controls="repositories-navbar-supported-content" aria-expanded="false" aria-label="Toggle navigation">
+                    <span class="navbar-toggler-icon"></span>
+                </button>
+
+                <div id="repositories-navbar-supported-content" class="collapse navbar-collapse">
+                    <ul id="repositories" class="nav nav-tabs">
+                        {% for repository in repositories %}
+                            <li class="nav-item">
+                                <a id="{{ repository.id }}-link" class="nav-link" href="#{{ repository.id }}" data-repository="{{ repository.repository }}" data-architecture="{{ repository.architecture }}">{{ repository.repository }} ({{ repository.architecture }})</a>
+                            </li>
+                        {% endfor %}
+                    </ul>
+                </div>
+            </nav>
+        </div>
+
+        <div id="alert-placeholder" class="toast-container p3 top-0 start-50 translate-middle-x"></div>
+
+        <div class="container">
+            <div id="toolbar" class="dropdown">
+                <a id="badge-status" tabindex="0" role="button" class="btn btn-outline-secondary" data-bs-toggle="popover" data-bs-trigger="focus" data-bs-content="no run data"><i class="bi bi-info-circle"></i></a>
+
+                {% if not auth.enabled or auth.username is not none %}
+                    <button type="button" class="btn btn-primary dropdown-toggle" data-bs-toggle="dropdown" aria-expanded="false">
+                        <i class="bi bi-box"></i><span class="d-none d-sm-inline"> packages</span>
+                    </button>
+                    <ul class="dropdown-menu">
+                        <li>
+                            <button id="package-add-button" class="btn dropdown-item" data-bs-toggle="modal" data-bs-target="#package-add-modal" hidden>
+                                <i class="bi bi-plus"></i> add
+                            </button>
+                        </li>
+                        <li>
+                            <button id="package-update-button" class="btn dropdown-item" onclick="packagesUpdate()" hidden>
+                                <i class="bi bi-play"></i> update
+                            </button>
+                        </li>
+                        <li>
+                            <button id="package-rebuild-button" class="btn dropdown-item" data-bs-toggle="modal" data-bs-target="#package-rebuild-modal" hidden>
+                                <i class="bi bi-arrow-clockwise"></i> rebuild
+                            </button>
+                        </li>
+                        <li>
+                            <button id="package-remove-button" class="btn dropdown-item" onclick="packagesRemove()" disabled hidden>
+                                <i class="bi bi-trash"></i> remove
+                            </button>
+                        </li>
+                    </ul>
+
+                    <button id="key-import-button" type="button" class="btn btn-info" data-bs-toggle="modal" data-bs-target="#key-import-modal" hidden>
+                        <i class="bi bi-key"></i><span class="d-none d-sm-inline"> import key</span>
+                    </button>
+                {% endif %}
+
+                <button type="button" class="btn btn-secondary" onclick="reload()">
+                    <i class="bi bi-arrow-clockwise"></i><span class="d-none d-sm-inline"> reload</span>
+                </button>
+            </div>
+
+            <table id="packages"
+                   data-classes="table table-hover"
+                   data-export-options='{"fileName": "packages"}'
+                   data-filter-control="true"
+                   data-filter-control-visible="false"
+                   data-page-list="[10, 25, 50, 100, all]"
+                   data-page-size="10"
+                   data-pagination="true"
+                   data-resizable="true"
+                   data-search="true"
+                   data-show-columns="true"
+                   data-show-columns-search="true"
+                   data-show-columns-toggle-all="true"
+                   data-show-export="true"
+                   data-show-filter-control-switch="true"
+                   data-show-fullscreen="true"
+                   data-show-search-clear-button="true"
+                   data-sortable="true"
+                   data-sort-name="base"
+                   data-sort-order="asc"
+                   data-toggle="table"
+                   data-toolbar="#toolbar">
+                <thead class="table-primary">
+                    <tr>
+                        <th data-checkbox="true"></th>
+                        <th data-sortable="true" data-switchable="false" data-field="base" data-filter-control="input" data-filter-control-placeholder="(any base)">package base</th>
+                        <th data-sortable="true" data-align="right" data-field="version" data-filter-control="input" data-filter-control-placeholder="(any version)">version</th>
+                        <th data-sortable="true" data-field="packages" data-filter-control="input" data-filter-control-placeholder="(any package)">packages</th>
+                        <th data-sortable="true" data-visible="false" data-field="groups" data-filter-control="select" data-filter-data="func:filterListGroups" data-filter-custom-search="filterList" data-filter-control-placeholder="(any group)">groups</th>
+                        <th data-sortable="true" data-visible="false" data-field="licenses" data-filter-control="select" data-filter-data="func:filterListLicenses" data-filter-custom-search="filterList" data-filter-control-placeholder="(any license)">licenses</th>
+                        <th data-sortable="true" data-visible="false" data-field="packager" data-filter-control="select" data-filter-custom-search="filterContains" data-filter-control-placeholder="(any packager)">packager</th>
+                        <th data-sortable="true" data-align="right" data-field="timestamp" data-filter-control="input" data-filter-custom-search="filterDateRange" data-filter-control-placeholder="(any date)">last update</th>
+                        <th data-sortable="true" data-align="center" data-cell-style="statusFormat" data-field="status" data-filter-control="select" data-filter-control-placeholder="(any status)">status</th>
+                    </tr>
+                </thead>
+            </table>
+        </div>
+
+        <div class="container">
+            <footer class="d-flex flex-wrap justify-content-between align-items-center border-top">
+                <ul class="nav">
+                    <li><a id="badge-version" class="nav-link" href="https://github.com/arcan1s/ahriman" title="sources"><i class="bi bi-github"></i> ahriman</a></li>
+                    <li><a class="nav-link" href="https://github.com/arcan1s/ahriman/releases" title="releases list">releases</a></li>
+                    <li><a class="nav-link" href="https://github.com/arcan1s/ahriman/issues" title="issues tracker">report a bug</a></li>
+                    <li><a class="nav-link" href="/api-docs" title="API documentation">api</a></li>
+                </ul>
+
+                {% if index_url is not none %}
+                    <ul class="nav">
+                        <li><a class="nav-link" href="{{ index_url }}" title="repo index"><i class="bi bi-house"></i> repo index</a></li>
+                    </ul>
+                {% endif %}
+
+                {% if auth.enabled %}
+                    <ul class="nav">
+                        {% if auth.username is none %}
+                            <li>{{ auth.control | safe }}</li>
+                        {% else %}
+                            <li>
+                                <form action="/api/v1/logout" method="post">
+                                    <button class="btn btn-link" style="text-decoration: none"><i class="bi bi-box-arrow-right"></i> logout ({{ auth.username }})</button>
+                                </form>
+                            </li>
+                        {% endif %}
+                    </ul>
+                {% endif %}
+            </footer>
+        </div>
+
+        {% if auth.enabled %}
+            {% include "build-status/login-modal.jinja2" %}
+        {% endif %}
+
+        {% include "build-status/alerts.jinja2" %}
+
+        {% include "build-status/package-add-modal.jinja2" %}
+        {% include "build-status/package-rebuild-modal.jinja2" %}
+        {% include "build-status/key-import-modal.jinja2" %}
+
+        {% include "build-status/package-info-modal.jinja2" %}
+
+        {% include "build-status/table.jinja2" %}
+
+    </body>
+
+</html>