Release 0.14.0

directory

README.md

@@ -15,13 +15,54 @@ Wrapper for managing custom repository inspired by [repo-scripts](https://github
 ## Installation and run
 
 * Install package as usual.
-* Change settings if required, see `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`).
-* Configure build tools (it might be required if your package will use any custom repositories):
-    * create build command, e.g. `ln -s /usr/bin/archbuild /usr/local/bin/custom-x86_64-build` (you can choose any name for command);
-    * create configuration file, e.g. `cp /usr/share/devtools/pacman-{extra,custom}.conf`;
-    * change configuration file, add your own repository, add multilib repository etc;
-    * set `build.build_command` setting to point to your command;
-    * configure `/etc/sudoers.d/ahriman` to allow running command without password.
-* Start and enable `ahriman.timer` via `systemctl`.
-* Add packages by using `ahriman add {package}` command.
+* 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
+    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):
+
+    * 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`);
+    * 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
+    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
+    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
+    echo 'SigLevel = Optional TrustAll' | tee -a /usr/share/devtools/pacman-ahriman.conf
+    echo 'Server = file:///var/lib/ahriman/repository/$arch' | tee -a /usr/share/devtools/pacman-ahriman.conf
+
+    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
+    ```

package/archlinux/PKGBUILD

@@ -1,7 +1,7 @@
 # Maintainer: Evgeniy Alekseev
 
 pkgname='ahriman'
-pkgver=0.11.7
+pkgver=0.14.0
 pkgrel=1
 pkgdesc="ArcHlinux ReposItory MANager"
 arch=('any')
@@ -23,7 +23,7 @@ optdepends=('aws-cli: sync to s3'
 source=("https://github.com/arcan1s/ahriman/releases/download/$pkgver/$pkgname-$pkgver-src.tar.xz"
         'ahriman.sysusers'
         'ahriman.tmpfiles')
-sha512sums=('d35053c7a52e5cc2dd8a3dca6c9d9f18788296d0059683b16238a54318a74fb4c42544d0727460250e7d0f0ce1009aca96e88d3e52e6bdffab8d45e5e4901b7b'
+sha512sums=('5d35e9173fdf3809e5b73fcac2976ccf2c528ad23e7faed17389647b728a609b037288b1d438413690fffad7c24d9abbdae0419ee575053fd1d0d88dae6d01a8'
             '13718afec2c6786a18f0b223ef8e58dccf0688bca4cdbe203f14071f5031ed20120eb0ce38b52c76cfd6e8b6581a9c9eaa2743eb11abbaca637451a84c33f075'
             '55b20f6da3d66e7bbf2add5d95a3b60632df121717d25a993e56e737d14f51fe063eb6f1b38bd81cc32e05db01c0c1d80aaa720c45cde87f238d8b46cdb8cbc4')
 backup=('etc/ahriman.ini'

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

@@ -2,17 +2,11 @@
 keys = root,builder,build_details,http
 
 [handlers]
-keys = console_handler,build_file_handler,file_handler,http_handler
+keys = build_file_handler,file_handler,http_handler
 
 [formatters]
 keys = generic_format
 
-[handler_console_handler]
-class = StreamHandler
-level = DEBUG
-formatter = generic_format
-args = (sys.stdout,)
-
 [handler_file_handler]
 class = logging.handlers.RotatingFileHandler
 level = DEBUG

package/share/ahriman/build-status.jinja2

@@ -11,7 +11,11 @@
 
     <body>
         <div class="root">
-            <h1>ahriman {{ version|e }} ({{ architecture|e }})</h1>
+            <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" %}
 
@@ -31,11 +35,19 @@
                             <td class="include-search">{{ package.packages|join("<br>"|safe) }}</td>
                             <td>{{ package.version|e }}</td>
                             <td>{{ package.timestamp|e }}</td>
-                            <td class="package-{{ package.status|e }}">{{ package.status|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>
 

package/share/ahriman/repo-index.jinja2

@@ -33,20 +33,30 @@
                     <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>
 
-            {% if homepage is not none %}
-                <footer><a href="{{ homepage|e }}" title="homepage">Homepage</a></footer>
-            {% endif %}
+            <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/style.jinja2

@@ -5,6 +5,11 @@
         --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 {
@@ -26,7 +31,7 @@
         padding: 15px 15% 0;
     }
 
-    section.element {
+    section.element, footer {
         width: 100%;
         padding: 10px 0;
     }
@@ -40,19 +45,23 @@
     }
 
     tr.package:nth-child(odd) {
-        background-color: rgba(255, 255, 255, 1);
+        background-color: rgba(var(--color-line-white), 1.0);
     }
 
     tr.package:nth-child(even) {
-        background-color: rgba(235, 235, 255, 1);
+        background-color: rgba(var(--color-line-blue), 1.0);
     }
 
     tr.package:hover {
-        background-color: rgba(255, 255, 225, 1);
+        background-color: rgba(var(--color-hover), 1.0);
     }
 
     tr.header{
-        background-color: rgba(200, 200, 255, 1);
+        background-color: rgba(var(--color-header), 1.0);
+    }
+
+    td.status {
+        text-align: center;
     }
 
     td.package-unknown {
@@ -75,4 +84,53 @@
     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>

src/ahriman/__init__.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify

src/ahriman/application/__init__.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify

src/ahriman/application/ahriman.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -18,6 +18,10 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
 import argparse
+import logging
+import sys
+
+from multiprocessing import Pool
 
 import ahriman.version as version
 
@@ -26,50 +30,143 @@ from ahriman.application.lock import Lock
 from ahriman.core.configuration import Configuration
 
 
-def add(args: argparse.Namespace) -> None:
-    Application.from_args(args).add(args.package, args.without_dependencies)
+def _call(args: argparse.Namespace, architecture: str, config: Configuration) -> bool:
+    '''
+    additional function to wrap all calls for multiprocessing library
+    :param args: command line args
+    :param architecture: repository architecture
+    :param config: configuration instance
+    :return: True on success, False otherwise
+    '''
+    try:
+        with Lock(args.lock, architecture, args.force, args.unsafe, config):
+            args.fn(args, architecture, config)
+        return True
+    except Exception:
+        logging.getLogger('root').exception('process exception', exc_info=True)
+        return False
 
 
-def rebuild(args: argparse.Namespace) -> None:
-    app = Application.from_args(args)
+def add(args: argparse.Namespace, architecture: str, config: Configuration) -> None:
+    '''
+    add packages callback
+    :param args: command line args
+    :param architecture: repository architecture
+    :param config: configuration instance
+    '''
+    Application(architecture, config).add(args.package, args.without_dependencies)
+
+
+def clean(args: argparse.Namespace, architecture: str, config: Configuration) -> None:
+    '''
+    clean caches callback
+    :param args: command line args
+    :param architecture: repository architecture
+    :param config: configuration instance
+    '''
+    Application(architecture, config).clean(args.no_build, args.no_cache, args.no_chroot,
+                                            args.no_manual, args.no_packages)
+
+
+def dump_config(args: argparse.Namespace, architecture: str, config: Configuration) -> None:
+    '''
+    configuration dump callback
+    :param args: command line args
+    :param architecture: repository architecture
+    :param config: configuration instance
+    '''
+    result = config.dump(architecture)
+    for section, values in sorted(result.items()):
+        print(f'[{section}]')
+        for key, value in sorted(values.items()):
+            print(f'{key} = {value}')
+        print()
+
+
+def rebuild(args: argparse.Namespace, architecture: str, config: Configuration) -> None:
+    '''
+    world rebuild callback
+    :param args: command line args
+    :param architecture: repository architecture
+    :param config: configuration instance
+    '''
+    app = Application(architecture, config)
     packages = app.repository.packages()
     app.update(packages)
 
 
-def remove(args: argparse.Namespace) -> None:
-    Application.from_args(args).remove(args.package)
+def remove(args: argparse.Namespace, architecture: str, config: Configuration) -> None:
+    '''
+    remove packages callback
+    :param args: command line args
+    :param architecture: repository architecture
+    :param config: configuration instance
+    '''
+    Application(architecture, config).remove(args.package)
 
 
-def report(args: argparse.Namespace) -> None:
-    Application.from_args(args).report(args.target)
+def report(args: argparse.Namespace, architecture: str, config: Configuration) -> None:
+    '''
+    generate report callback
+    :param args: command line args
+    :param architecture: repository architecture
+    :param config: configuration instance
+    '''
+    Application(architecture, config).report(args.target)
 
 
-def sync(args: argparse.Namespace) -> None:
-    Application.from_args(args).sync(args.target)
+def sync(args: argparse.Namespace, architecture: str, config: Configuration) -> None:
+    '''
+    sync to remote server callback
+    :param args: command line args
+    :param architecture: repository architecture
+    :param config: configuration instance
+    '''
+    Application(architecture, config).sync(args.target)
 
 
-def update(args: argparse.Namespace) -> None:
-    app = Application.from_args(args)
-    log_fn = lambda line: print(line) if args.dry_run else app.logger.info(line)
-    packages = app.get_updates(args.package, args.no_aur, args.no_manual, args.no_vcs, log_fn)
+def update(args: argparse.Namespace, architecture: str, config: Configuration) -> None:
+    '''
+    update packages callback
+    :param args: command line args
+    :param architecture: repository architecture
+    :param config: configuration instance
+    '''
+    # typing workaround
+    def log_fn(line: str) -> None:
+        return print(line) if args.dry_run else application.logger.info(line)
+
+    application = Application(architecture, config)
+    packages = application.get_updates(args.package, args.no_aur, args.no_manual, args.no_vcs, log_fn)
     if args.dry_run:
         return
-    app.update(packages)
+
+    application.update(packages)
 
 
-def web(args: argparse.Namespace) -> None:
+def web(args: argparse.Namespace, architecture: str, config: Configuration) -> None:
+    '''
+    web server callback
+    :param args: command line args
+    :param architecture: repository architecture
+    :param config: configuration instance
+    '''
     from ahriman.web.web import run_server, setup_service
-    config = Configuration.from_path(args.config)
-    app = setup_service(args.architecture, config)
-    run_server(app, args.architecture)
+    application = setup_service(architecture, config)
+    run_server(application, architecture)
 
 
 if __name__ == '__main__':
     parser = argparse.ArgumentParser(prog='ahriman', description='ArcHlinux ReposItory MANager')
-    parser.add_argument('-a', '--architecture', help='target architecture', required=True)
+    parser.add_argument(
+        '-a',
+        '--architecture',
+        help='target architectures (can be used multiple times)',
+        action='append')
     parser.add_argument('-c', '--config', help='configuration path', default='/etc/ahriman.ini')
     parser.add_argument('--force', help='force run, remove file lock', action='store_true')
     parser.add_argument('--lock', help='lock file', default='/tmp/ahriman.lock')
+    parser.add_argument('--unsafe', help='allow to run ahriman as non-ahriman user', action='store_true')
     parser.add_argument('-v', '--version', action='version', version=version.__version__)
     subparsers = parser.add_subparsers(title='command')
 
@@ -80,7 +177,22 @@ if __name__ == '__main__':
 
     check_parser = subparsers.add_parser('check', description='check for updates')
     check_parser.add_argument('package', help='filter check by packages', nargs='*')
-    check_parser.set_defaults(fn=update, no_aur=False, no_manual=True, no_vcs=False, dry_run=True)
+    check_parser.add_argument('--no-vcs', help='do not check VCS packages', action='store_true')
+    check_parser.set_defaults(fn=update, no_aur=False, no_manual=True, dry_run=True)
+
+    clean_parser = subparsers.add_parser('clean', description='clear all local caches')
+    clean_parser.add_argument('--no-build', help='do not clear directory with package sources', action='store_true')
+    clean_parser.add_argument('--no-cache', help='do not clear directory with package caches', action='store_true')
+    clean_parser.add_argument('--no-chroot', help='do not clear build chroot', action='store_true')
+    clean_parser.add_argument(
+        '--no-manual',
+        help='do not clear directory with manually added packages',
+        action='store_true')
+    clean_parser.add_argument('--no-packages', help='do not clear directory with built packages', action='store_true')
+    clean_parser.set_defaults(fn=clean)
+
+    config_parser = subparsers.add_parser('config', description='dump configuration for specified architecture')
+    config_parser.set_defaults(fn=dump_config)
 
     rebuild_parser = subparsers.add_parser('rebuild', description='rebuild whole repository')
     rebuild_parser.set_defaults(fn=rebuild)
@@ -99,7 +211,8 @@ if __name__ == '__main__':
 
     update_parser = subparsers.add_parser('update', description='run updates')
     update_parser.add_argument('package', help='filter check by packages', nargs='*')
-    update_parser.add_argument('--dry-run', help='just perform check for updates, same as check command', action='store_true')
+    update_parser.add_argument(
+        '--dry-run', help='just perform check for updates, same as check command', action='store_true')
     update_parser.add_argument('--no-aur', help='do not check for AUR updates', action='store_true')
     update_parser.add_argument('--no-manual', help='do not include manual updates', action='store_true')
     update_parser.add_argument('--no-vcs', help='do not check VCS packages', action='store_true')
@@ -113,5 +226,8 @@ if __name__ == '__main__':
         parser.print_help()
         exit(1)
 
-    with Lock(args.lock, args.architecture, args.force):
-        args.fn(args)
+    config = Configuration.from_path(args.config)
+    with Pool(len(args.architecture)) as pool:
+        result = pool.starmap(_call, [(args, architecture, config) for architecture in args.architecture])
+
+    sys.exit(0 if all(result) else 1)

src/ahriman/application/application.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -17,14 +17,11 @@
 # You should have received a copy of the GNU General Public License
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
-from __future__ import annotations
-
-import argparse
 import logging
 import os
 import shutil
 
-from typing import Callable, Iterable, List, Optional, Set, Type
+from typing import Callable, Iterable, List, Optional, Set
 
 from ahriman.core.build_tools.task import Task
 from ahriman.core.configuration import Configuration
@@ -34,19 +31,30 @@ from ahriman.models.package import Package
 
 
 class Application:
+    '''
+    base application class
+    :ivar architecture: repository architecture
+    :ivar config: configuration instance
+    :ivar logger: application logger
+    :ivar repository: repository instance
+    '''
 
     def __init__(self, architecture: str, config: Configuration) -> None:
+        '''
+        default constructor
+        :param architecture: repository architecture
+        :param config: configuration instance
+        '''
         self.logger = logging.getLogger('root')
         self.config = config
         self.architecture = architecture
         self.repository = Repository(architecture, config)
 
-    @classmethod
-    def from_args(cls: Type[Application], args: argparse.Namespace) -> Application:
-        config = Configuration.from_path(args.config)
-        return cls(args.architecture, config)
-
     def _known_packages(self) -> Set[str]:
+        '''
+        load packages from repository and pacman repositories
+        :return: list of known packages
+        '''
         known_packages: Set[str] = set()
         # local set
         for package in self.repository.packages():
@@ -55,11 +63,23 @@ class Application:
         return known_packages
 
     def _finalize(self) -> None:
+        '''
+        generate report and sync to remote server
+        '''
         self.report()
         self.sync()
 
     def get_updates(self, filter_packages: List[str], no_aur: bool, no_manual: bool, no_vcs: bool,
                     log_fn: Callable[[str], None]) -> List[Package]:
+        '''
+        get list of packages to run update process
+        :param filter_packages: do not check every package just specified in the list
+        :param no_aur: do not check for aur updates
+        :param no_manual: do not check for manual updates
+        :param no_vcs: do not check VCS packages
+        :param log_fn: logger function to log updates
+        :return: list of out-of-dated packages
+        '''
         updates = []
 
         if not no_aur:
@@ -73,6 +93,11 @@ class Application:
         return updates
 
     def add(self, names: Iterable[str], without_dependencies: bool) -> None:
+        '''
+        add packages for the next build
+        :param names: list of package bases to add
+        :param without_dependencies: if set, dependency check will be disabled
+        '''
         known_packages = self._known_packages()
 
         def add_manual(name: str) -> str:
@@ -101,19 +126,55 @@ class Application:
         for name in names:
             process_single(name)
 
+    def clean(self, no_build: bool, no_cache: bool, no_chroot: bool, no_manual: bool, no_packages: bool) -> None:
+        '''
+        run all clean methods. Warning: some functions might not be available under non-root
+        :param no_build: do not clear directory with package sources
+        :param no_cache: do not clear directory with package caches
+        :param no_chroot: do not clear build chroot
+        :param no_manual: do not clear directory with manually added packages
+        :param no_packages: do not clear directory with built packages
+        '''
+        if not no_build:
+            self.repository._clear_build()
+        if not no_cache:
+            self.repository._clear_cache()
+        if not no_chroot:
+            self.repository._clear_chroot()
+        if not no_manual:
+            self.repository._clear_manual()
+        if not no_packages:
+            self.repository._clear_packages()
+
     def remove(self, names: Iterable[str]) -> None:
+        '''
+        remove packages from repository
+        :param names: list of packages (either base or name) to remove
+        '''
         self.repository.process_remove(names)
         self._finalize()
 
     def report(self, target: Optional[Iterable[str]] = None) -> None:
+        '''
+        generate report
+        :param target: list of targets to run (e.g. html)
+        '''
         targets = target or None
         self.repository.process_report(targets)
 
     def sync(self, target: Optional[Iterable[str]] = None) -> None:
+        '''
+        sync to remote server
+        :param target: list of targets to run (e.g. s3)
+        '''
         targets = target or None
         self.repository.process_sync(targets)
 
     def update(self, updates: Iterable[Package]) -> None:
+        '''
+        run package updates
+        :param updates: list of packages to update
+        '''
         def process_update(paths: Iterable[str]) -> None:
             self.repository.process_update(paths)
             self._finalize()
@@ -128,4 +189,4 @@ class Application:
         for num, level in enumerate(tree.levels()):
             self.logger.info(f'processing level #{num} {[package.base for package in level]}')
             packages = self.repository.process_build(level)
-            process_update(packages)
+            process_update(packages)

src/ahriman/application/lock.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -24,40 +24,104 @@ import os
 from types import TracebackType
 from typing import Literal, Optional, Type
 
-from ahriman.core.exceptions import DuplicateRun
+from ahriman.core.configuration import Configuration
+from ahriman.core.exceptions import DuplicateRun, UnsafeRun
+from ahriman.core.watcher.client import Client
+from ahriman.models.build_status import BuildStatusEnum
 
 
 class Lock:
+    '''
+    wrapper for application lock file
+    :ivar force: remove lock file on start if any
+    :ivar path: path to lock file if any
+    :ivar reporter: build status reporter instance
+    :ivar root: repository root (i.e. ahriman home)
+    :ivar unsafe: skip user check
+    '''
 
-    def __init__(self, path: Optional[str], architecture: str, force: bool) -> None:
+    def __init__(self, path: Optional[str], architecture: str, force: bool, unsafe: bool,
+                 config: Configuration) -> None:
+        '''
+        default constructor
+        :param path: optional path to lock file, if empty no file lock will be used
+        :param architecture: repository architecture
+        :param force: remove lock file on start if any
+        :param unsafe: skip user check
+        :param config: configuration instance
+        '''
         self.path = f'{path}_{architecture}' if path is not None else None
         self.force = force
+        self.unsafe = unsafe
+
+        self.root = config.get('repository', 'root')
+        self.reporter = Client.load(architecture, config)
 
     def __enter__(self) -> Lock:
+        '''
+        default workflow is the following:
+
+            check user UID
+            remove lock file if force flag is set
+            check if there is lock file
+            create lock file
+            report to web if enabled
+        '''
+        self.check_user()
         if self.force:
             self.remove()
         self.check()
         self.create()
+        self.reporter.update_self(BuildStatusEnum.Building)
         return self
 
     def __exit__(self, exc_type: Optional[Type[Exception]], exc_val: Optional[Exception],
                  exc_tb: TracebackType) -> Literal[False]:
+        '''
+        remove lock file when done
+        :param exc_type: exception type name if any
+        :param exc_val: exception raised if any
+        :param exc_tb: exception traceback if any
+        :return: always False (do not suppress any exception)
+        '''
         self.remove()
+        status = BuildStatusEnum.Success if exc_val is None else BuildStatusEnum.Failed
+        self.reporter.update_self(status)
         return False
 
     def check(self) -> None:
+        '''
+        check if lock file exists, raise exception if it does
+        '''
         if self.path is None:
             return
         if os.path.exists(self.path):
             raise DuplicateRun()
 
+    def check_user(self) -> None:
+        '''
+        check if current user is actually owner of ahriman root
+        '''
+        if self.unsafe:
+            return
+        current_uid = os.getuid()
+        root_uid = os.stat(self.root).st_uid
+        if current_uid != root_uid:
+            raise UnsafeRun(current_uid, root_uid)
+
     def create(self) -> None:
+        '''
+        create lock file
+        '''
         if self.path is None:
             return
         open(self.path, 'w').close()
 
     def remove(self) -> None:
+        '''
+        remove lock file
+        '''
         if self.path is None:
             return
         if os.path.exists(self.path):
-            os.remove(self.path)
+            os.remove(self.path)

src/ahriman/core/__init__.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify

src/ahriman/core/alpm/__init__.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify

src/ahriman/core/alpm/pacman.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -24,8 +24,16 @@ from ahriman.core.configuration import Configuration
 
 
 class Pacman:
+    '''
+    alpm wrapper
+    :ivar handle: pyalpm root `Handle`
+    '''
 
     def __init__(self, config: Configuration) -> None:
+        '''
+        default constructor
+        :param config: configuration instance
+        '''
         root = config.get('alpm', 'root')
         pacman_root = config.get('alpm', 'database')
         self.handle = Handle(root, pacman_root)
@@ -33,8 +41,12 @@ class Pacman:
             self.handle.register_syncdb(repository, 0)  # 0 is pgp_level
 
     def all_packages(self) -> List[str]:
+        '''
+        get list of packages known for alpm
+        :return: list of package names
+        '''
         result: Set[str] = set()
         for database in self.handle.get_syncdbs():
             result.update({package.name for package in database.pkgcache})
 
-        return list(result)
+        return list(result)

src/ahriman/core/alpm/repo.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -28,8 +28,21 @@ from ahriman.models.repository_paths import RepositoryPaths
 
 
 class Repo:
+    '''
+    repo-add and repo-remove wrapper
+    :ivar logger: class logger
+    :ivar name: repository name
+    :ivar paths: repository paths instance
+    :ivar sign_args: additional args which have to be used to sign repository archive
+    '''
 
     def __init__(self, name: str, paths: RepositoryPaths, sign_args: List[str]) -> None:
+        '''
+        default constructor
+        :param name: repository name
+        :param paths: repository paths instance
+        :param sign_args: additional args which have to be used to sign repository archive
+        '''
         self.logger = logging.getLogger('build_details')
         self.name = name
         self.paths = paths
@@ -37,19 +50,32 @@ class Repo:
 
     @property
     def repo_path(self) -> str:
+        '''
+        :return: path to repository database
+        '''
         return os.path.join(self.paths.repository, f'{self.name}.db.tar.gz')
 
     def add(self, path: str) -> None:
+        '''
+        add new package to repository
+        :param path: path to archive to add
+        '''
         check_output(
             'repo-add', *self.sign_args, '-R', self.repo_path, path,
             exception=BuildFailed(path),
             cwd=self.paths.repository,
             logger=self.logger)
 
-    def remove(self, prefix: str, package: str) -> None:
-        for fn in filter(lambda f: f.startswith(prefix), os.listdir(self.paths.repository)):
+    def remove(self, package: str) -> None:
+        '''
+        remove package from repository
+        :param package: package name to remove
+        '''
+        # remove package and signature (if any) from filesystem
+        for fn in filter(lambda f: f.startswith(package), os.listdir(self.paths.repository)):
             full_path = os.path.join(self.paths.repository, fn)
             os.remove(full_path)
+        # remove package from registry
         check_output(
             'repo-remove', *self.sign_args, self.repo_path, package,
             exception=BuildFailed(package),

src/ahriman/core/build_tools/__init__.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify

src/ahriman/core/build_tools/task.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -31,8 +31,22 @@ from ahriman.models.repository_paths import RepositoryPaths
 
 
 class Task:
+    '''
+    base package build task
+    :ivar build_logger: logger for build process
+    :ivar logger: class logger
+    :ivar package: package definitions
+    :ivar paths: repository paths instance
+    '''
 
     def __init__(self, package: Package, architecture: str, config: Configuration, paths: RepositoryPaths) -> None:
+        '''
+        default constructor
+        :param package: package definitions
+        :param architecture: repository architecture
+        :param config: configuration instance
+        :param paths: repository paths instance
+        '''
         self.logger = logging.getLogger('builder')
         self.build_logger = logging.getLogger('build_details')
         self.package = package
@@ -44,16 +58,42 @@ class Task:
         self.makepkg_flags = config.getlist(section, 'makepkg_flags')
         self.makechrootpkg_flags = config.getlist(section, 'makechrootpkg_flags')
 
+    @property
+    def cache_path(self) -> str:
+        '''
+        :return: path to cached packages
+        '''
+        return os.path.join(self.paths.cache, self.package.base)
+
     @property
     def git_path(self) -> str:
+        '''
+        :return: path to clone package from git
+        '''
         return os.path.join(self.paths.sources, self.package.base)
 
     @staticmethod
-    def fetch(local: str, remote: str) -> None:
-        shutil.rmtree(local, ignore_errors=True)  # remove in case if file exists
-        check_output('git', 'clone', remote, local, exception=None)
+    def fetch(local: str, remote: str, branch: str = 'master') -> None:
+        '''
+        either clone repository or update it to origin/`branch`
+        :param local: local path to fetch
+        :param remote: remote target (from where to fetch)
+        :param branch: branch name to checkout, master by default
+        '''
+        logger = logging.getLogger('build_details')
+        # local directory exists and there is .git directory
+        if os.path.isdir(os.path.join(local, '.git')):
+            check_output('git', 'fetch', 'origin', branch, exception=None, cwd=local, logger=logger)
+        else:
+            check_output('git', 'clone', remote, local, exception=None, logger=logger)
+        # and now force reset to our branch
+        check_output('git', 'reset', '--hard', f'origin/{branch}', exception=None, cwd=local, logger=logger)
 
     def build(self) -> List[str]:
+        '''
+        run package build
+        :return: paths of produced packages
+        '''
         cmd = [self.build_command, '-r', self.paths.chroot]
         cmd.extend(self.archbuild_flags)
         cmd.extend(['--'] + self.makechrootpkg_flags)
@@ -69,8 +109,16 @@ class Task:
         # well it is not actually correct, but we can deal with it
         return check_output('makepkg', '--packagelist',
                             exception=BuildFailed(self.package.base),
-                            cwd=self.git_path).splitlines()
+                            cwd=self.git_path,
+                            logger=self.build_logger).splitlines()
 
-    def clone(self, path: Optional[str] = None) -> None:
+    def init(self, path: Optional[str] = None) -> None:
+        '''
+        fetch package from git
+        :param path: optional local path to fetch. If not set default path will be used
+        '''
         git_path = path or self.git_path
+        if os.path.isdir(self.cache_path):
+            # no need to clone whole repository, just copy from cache first
+            shutil.copytree(self.cache_path, git_path)
         return Task.fetch(git_path, self.package.git_url)

src/ahriman/core/configuration.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -20,46 +20,109 @@
 from __future__ import annotations
 
 import configparser
+import logging
 import os
 
 from logging.config import fileConfig
-from typing import List, Optional, Type
+from typing import Dict, List, Optional, Type
 
 
-# built-in configparser extension
 class Configuration(configparser.RawConfigParser):
+    '''
+    extension for built-in configuration parser
+    :ivar path: path to root configuration file
+    :cvar ARCHITECTURE_SPECIFIC_SECTIONS: known sections which can be architecture specific (required by dump)
+    :cvar DEFAULT_LOG_FORMAT: default log format (in case of fallback)
+    :cvar DEFAULT_LOG_LEVEL: default log level (in case of fallback)
+    :cvar STATIC_SECTIONS: known sections which are not architecture specific (required by dump)
+    '''
+
+    DEFAULT_LOG_FORMAT = '%(asctime)s : %(levelname)s : %(funcName)s : %(message)s'
+    DEFAULT_LOG_LEVEL = logging.DEBUG
+
+    STATIC_SECTIONS = ['alpm', 'report', 'repository', 'settings', 'upload']
+    ARCHITECTURE_SPECIFIC_SECTIONS = ['build', 'html', 'rsync', 's3', 'sign', 'web']
 
     def __init__(self) -> None:
+        '''
+        default constructor
+        '''
         configparser.RawConfigParser.__init__(self, allow_no_value=True)
         self.path: Optional[str] = None
 
     @property
     def include(self) -> str:
+        '''
+        :return: path to directory with configuration includes
+        '''
         return self.get('settings', 'include')
 
     @classmethod
     def from_path(cls: Type[Configuration], path: str) -> Configuration:
+        '''
+        constructor with full object initialization
+        :param path: path to root configuration file
+        :return: configuration instance
+        '''
         config = cls()
         config.load(path)
         config.load_logging()
         return config
 
+    def dump(self, architecture: str) -> Dict[str, Dict[str, str]]:
+        '''
+        dump configuration to dictionary
+        :param architecture: repository architecture
+        :return: configuration dump for specific architecture
+        '''
+        result: Dict[str, Dict[str, str]] = {}
+        for section in Configuration.STATIC_SECTIONS:
+            if not self.has_section(section):
+                continue
+            result[section] = dict(self[section])
+        for group in Configuration.ARCHITECTURE_SPECIFIC_SECTIONS:
+            section = self.get_section_name(group, architecture)
+            if not self.has_section(section):
+                continue
+            result[section] = dict(self[section])
+
+        return result
+
     def getlist(self, section: str, key: str) -> List[str]:
+        '''
+        get space separated string list option
+        :param section: section name
+        :param key: key name
+        :return: list of string if option is set, empty list otherwise
+        '''
         raw = self.get(section, key, fallback=None)
         if not raw:  # empty string or none
             return []
         return raw.split()
 
     def get_section_name(self, prefix: str, suffix: str) -> str:
+        '''
+        check if there is `prefix`_`suffix` section and return it on success. Return `prefix` otherwise
+        :param prefix: section name prefix
+        :param suffix: section name suffix (e.g. architecture name)
+        :return: found section name
+        '''
         probe = f'{prefix}_{suffix}'
         return probe if self.has_section(probe) else prefix
 
     def load(self, path: str) -> None:
+        '''
+        fully load configuration
+        :param path: path to root configuration file
+        '''
         self.path = path
         self.read(self.path)
         self.load_includes()
 
     def load_includes(self) -> None:
+        '''
+        load configuration includes
+        '''
         try:
             for conf in filter(lambda p: p.endswith('.ini'), sorted(os.listdir(self.include))):
                 self.read(os.path.join(self.include, conf))
@@ -67,4 +130,12 @@ class Configuration(configparser.RawConfigParser):
             pass
 
     def load_logging(self) -> None:
-        fileConfig(self.get('settings', 'logging'))
+        '''
+        setup logging settings from configuration
+        '''
+        try:
+            fileConfig(self.get('settings', 'logging'))
+        except PermissionError:
+            logging.basicConfig(filename=None, format=Configuration.DEFAULT_LOG_FORMAT,
+                                level=Configuration.DEFAULT_LOG_LEVEL)
+            logging.error('could not create logfile, fallback to stderr', exc_info=True)

src/ahriman/core/exceptions.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -21,35 +21,103 @@ from typing import Any
 
 
 class BuildFailed(Exception):
+    '''
+    base exception for failed builds
+    '''
+
     def __init__(self, package: str) -> None:
+        '''
+        default constructor
+        :param package: package base raised exception
+        '''
         Exception.__init__(self, f'Package {package} build failed, check logs for details')
 
 
 class DuplicateRun(Exception):
+    '''
+    exception which will be raised if there is another application instance
+    '''
+
     def __init__(self) -> None:
+        '''
+        default constructor
+        '''
         Exception.__init__(self, 'Another application instance is run')
 
 
 class InitializeException(Exception):
+    '''
+    base service initialization exception
+    '''
+
     def __init__(self) -> None:
+        '''
+        default constructor
+        '''
         Exception.__init__(self, 'Could not load service')
 
 
 class InvalidOption(Exception):
+    '''
+    exception which will be raised on configuration errors
+    '''
+
     def __init__(self, value: Any) -> None:
+        '''
+        default constructor
+        :param value: option value
+        '''
         Exception.__init__(self, f'Invalid or unknown option value `{value}`')
 
 
 class InvalidPackageInfo(Exception):
+    '''
+    exception which will be raised on package load errors
+    '''
+
     def __init__(self, details: Any) -> None:
+        '''
+        default constructor
+        :param details: error details
+        '''
         Exception.__init__(self, f'There are errors during reading package information: `{details}`')
 
 
 class ReportFailed(Exception):
+    '''
+    report generation exception
+    '''
+
     def __init__(self) -> None:
+        '''
+        default constructor
+        '''
         Exception.__init__(self, 'Report failed')
 
 
 class SyncFailed(Exception):
+    '''
+    remote synchronization exception
+    '''
+
     def __init__(self) -> None:
-        Exception.__init__(self, 'Sync failed')
+        '''
+        default constructor
+        '''
+        Exception.__init__(self, 'Sync failed')
+
+
+class UnsafeRun(Exception):
+    '''
+    exception which will be raised in case if user is not owner of repository
+    '''
+
+    def __init__(self, current_uid: int, root_uid: int) -> None:
+        '''
+        default constructor
+        '''
+        Exception.__init__(
+            self,
+            f'''Current UID {current_uid} differs from root owner {root_uid}.
+Note that for the most actions it is unsafe to run application as different user.
+If you are 100% sure that it must be there try --unsafe option''')

src/ahriman/core/report/__init__.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify

src/ahriman/core/report/html.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -24,13 +24,40 @@ from typing import Callable, Dict, Iterable
 
 from ahriman.core.configuration import Configuration
 from ahriman.core.report.report import Report
+from ahriman.core.util import pretty_size, pretty_datetime
 from ahriman.models.package import Package
 from ahriman.models.sign_settings import SignSettings
 
 
 class HTML(Report):
+    '''
+    html report generator
+
+    It uses jinja2 templates for report generation, the following variables are allowed:
+
+        homepage - link to homepage, string, optional
+        link_path - prefix fo packages to download, string, required
+        has_package_signed - True in case if package sign enabled, False otherwise, required
+        has_repo_signed - True in case if repository database sign enabled, False otherwise, required
+        packages - sorted list of packages properties: archive_size, build_date, filename, installed_size, name, version. Required
+        pgp_key - default PGP key ID, string, optional
+        repository - repository name, string, required
+
+    :ivar homepage: homepage link if any (for footer)
+    :ivar link_path: prefix fo packages to download
+    :ivar name: repository name
+    :ivar pgp_key: default PGP key
+    :ivar report_path: output path to html report
+    :ivar sign_targets: targets to sign enabled in configuration
+    :ivar tempate_path: path to directory with jinja templates
+    '''
 
     def __init__(self, architecture: str, config: Configuration) -> None:
+        '''
+        default constructor
+        :param architecture: repository architecture
+        :param config: configuration instance
+        '''
         Report.__init__(self, architecture, config)
         section = config.get_section_name('html', architecture)
         self.report_path = config.get(section, 'path')
@@ -39,13 +66,17 @@ class HTML(Report):
 
         # base template vars
         self.homepage = config.get(section, 'homepage', fallback=None)
-        self.repository = config.get('repository', 'name')
+        self.name = config.get('repository', 'name')
 
         sign_section = config.get_section_name('sign', architecture)
         self.sign_targets = [SignSettings.from_option(opt) for opt in config.getlist(sign_section, 'target')]
         self.pgp_key = config.get(sign_section, 'key') if self.sign_targets else None
 
     def generate(self, packages: Iterable[Package]) -> None:
+        '''
+        generate report for the specified packages
+        :param packages: list of packages to generate report
+        '''
         # idea comes from https://stackoverflow.com/a/38642558
         templates_dir, template_name = os.path.split(self.template_path)
         loader = jinja2.FileSystemLoader(searchpath=templates_dir)
@@ -54,10 +85,13 @@ class HTML(Report):
 
         content = [
             {
-                'filename': filename,
+                'archive_size': pretty_size(properties.archive_size),
+                'build_date': pretty_datetime(properties.build_date),
+                'filename': properties.filename,
+                'installed_size': pretty_size(properties.installed_size),
                 'name': package,
                 'version': base.version
-            } for base in packages for package, filename in base.packages.items()
+            } for base in packages for package, properties in base.packages.items()
         ]
         comparator: Callable[[Dict[str, str]], str] = lambda item: item['filename']
 
@@ -68,7 +102,7 @@ class HTML(Report):
             has_repo_signed=SignSettings.SignRepository in self.sign_targets,
             packages=sorted(content, key=comparator),
             pgp_key=self.pgp_key,
-            repository=self.repository)
+            repository=self.name)
 
         with open(self.report_path, 'w') as out:
             out.write(html)

src/ahriman/core/report/report.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -28,14 +28,32 @@ from ahriman.models.report_settings import ReportSettings
 
 
 class Report:
+    '''
+    base report generator
+    :ivar architecture: repository architecture
+    :ivar config: configuration instance
+    :ivar logger: class logger
+    '''
 
     def __init__(self, architecture: str, config: Configuration) -> None:
+        '''
+        default constructor
+        :param architecture: repository architecture
+        :param config: configuration instance
+        '''
         self.logger = logging.getLogger('builder')
         self.architecture = architecture
         self.config = config
 
     @staticmethod
     def run(architecture: str, config: Configuration, target: str, packages: Iterable[Package]) -> None:
+        '''
+        run report generation
+        :param architecture: repository architecture
+        :param config: configuration instance
+        :param target: target to generate report (e.g. html)
+        :param packages: list of packages to generate report
+        '''
         provider = ReportSettings.from_option(target)
         if provider == ReportSettings.HTML:
             from ahriman.core.report.html import HTML
@@ -50,4 +68,8 @@ class Report:
             raise ReportFailed()
 
     def generate(self, packages: Iterable[Package]) -> None:
-        pass
+        '''
+        generate report for the specified packages
+        :param packages: list of packages to generate report
+        '''
+        pass

src/ahriman/core/repository.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -37,8 +37,26 @@ from ahriman.models.repository_paths import RepositoryPaths
 
 
 class Repository:
+    '''
+    base repository control class
+    :ivar architecture: repository architecture
+    :ivar aur_url: base AUR url
+    :ivar config: configuration instance
+    :ivar logger: class logger
+    :ivar name: repository name
+    :ivar pacman: alpm wrapper instance
+    :ivar paths: repository paths instance
+    :ivar repo: repo commands wrapper instance
+    :ivar reporter: build status reporter instance
+    :ivar sign: GPG wrapper instance
+    '''
 
     def __init__(self, architecture: str, config: Configuration) -> None:
+        '''
+        default constructor
+        :param architecture: repository architecture
+        :param config: configuration instance
+        '''
         self.logger = logging.getLogger('builder')
         self.architecture = architecture
         self.config = config
@@ -52,21 +70,48 @@ class Repository:
         self.pacman = Pacman(config)
         self.sign = GPG(architecture, config)
         self.repo = Repo(self.name, self.paths, self.sign.repository_sign_args)
-        self.web = Client.load(architecture, config)
+        self.reporter = Client.load(architecture, config)
 
     def _clear_build(self) -> None:
+        '''
+        clear sources directory
+        '''
         for package in os.listdir(self.paths.sources):
             shutil.rmtree(os.path.join(self.paths.sources, package))
 
+    def _clear_cache(self) -> None:
+        '''
+        clear cache directory
+        '''
+        for package in os.listdir(self.paths.cache):
+            shutil.rmtree(os.path.join(self.paths.cache, package))
+
+    def _clear_chroot(self) -> None:
+        '''
+        clear cache directory. Warning: this method is architecture independent and will clear every chroot
+        '''
+        for chroot in os.listdir(self.paths.chroot):
+            shutil.rmtree(os.path.join(self.paths.chroot, chroot))
+
     def _clear_manual(self) -> None:
+        '''
+        clear directory with manual package updates
+        '''
         for package in os.listdir(self.paths.manual):
             shutil.rmtree(os.path.join(self.paths.manual, package))
 
     def _clear_packages(self) -> None:
+        '''
+        clear directory with built packages (NOT repository itself)
+        '''
         for package in self.packages_built():
             os.remove(package)
 
     def packages(self) -> List[Package]:
+        '''
+        generate list of repository packages
+        :return: list of packages properties
+        '''
         result: Dict[str, Package] = {}
         for fn in os.listdir(self.paths.repository):
             if not package_like(fn):
@@ -81,16 +126,25 @@ class Repository:
         return list(result.values())
 
     def packages_built(self) -> List[str]:
+        '''
+        get list of files in built packages directory
+        :return: list of filenames from the directory
+        '''
         return [
             os.path.join(self.paths.packages, fn)
             for fn in os.listdir(self.paths.packages)
         ]
 
     def process_build(self, updates: Iterable[Package]) -> List[str]:
+        '''
+        build packages
+        :param updates: list of packages properties to build
+        :return: `packages_built`
+        '''
         def build_single(package: Package) -> None:
-            self.web.set_building(package.base)
+            self.reporter.set_building(package.base)
             task = Task(package, self.architecture, self.config, self.paths)
-            task.clone()
+            task.init()
             built = task.build()
             for src in built:
                 dst = os.path.join(self.paths.packages, os.path.basename(src))
@@ -100,7 +154,7 @@ class Repository:
             try:
                 build_single(package)
             except Exception:
-                self.web.set_failed(package.base)
+                self.reporter.set_failed(package.base)
                 self.logger.exception(f'{package.base} ({self.architecture}) build exception', exc_info=True)
                 continue
         self._clear_build()
@@ -108,9 +162,14 @@ class Repository:
         return self.packages_built()
 
     def process_remove(self, packages: Iterable[str]) -> str:
+        '''
+        remove packages from list
+        :param packages: list of package names or bases to rmeove
+        :return: path to repository database
+        '''
         def remove_single(package: str) -> None:
             try:
-                self.repo.remove(package, package)
+                self.repo.remove(package)
             except Exception:
                 self.logger.exception(f'could not remove {package}', exc_info=True)
 
@@ -118,29 +177,42 @@ class Repository:
         for local in self.packages():
             if local.base in packages:
                 to_remove = set(local.packages.keys())
+                self.reporter.remove(local.base)  # we only update status page in case of base removal
             elif requested.intersection(local.packages.keys()):
                 to_remove = requested.intersection(local.packages.keys())
             else:
                 to_remove = set()
-            self.web.remove(local.base, to_remove)
             for package in to_remove:
                 remove_single(package)
 
         return self.repo.repo_path
 
     def process_report(self, targets: Optional[Iterable[str]]) -> None:
+        '''
+        generate reports
+        :param targets: list of targets to generate reports. Configuration option will be used if it is not set
+        '''
         if targets is None:
             targets = self.config.getlist('report', 'target')
         for target in targets:
             Report.run(self.architecture, self.config, target, self.packages())
 
     def process_sync(self, targets: Optional[Iterable[str]]) -> None:
+        '''
+        process synchronization to remote servers
+        :param targets: list of targets to sync. Configuration option will be used if it is not set
+        '''
         if targets is None:
             targets = self.config.getlist('upload', 'target')
         for target in targets:
             Uploader.run(self.architecture, self.config, target, self.paths.repository)
 
     def process_update(self, packages: Iterable[str]) -> str:
+        '''
+        sign packages, add them to repository and update repository database
+        :param packages: list of filenames to run
+        :return: path to repository database
+        '''
         for package in packages:
             local = Package.load(package, self.pacman, self.aur_url)  # we will use it for status reports
             try:
@@ -150,15 +222,21 @@ class Repository:
                     shutil.move(src, dst)
                 package_fn = os.path.join(self.paths.repository, os.path.basename(package))
                 self.repo.add(package_fn)
-                self.web.set_success(local)
+                self.reporter.set_success(local)
             except Exception:
                 self.logger.exception(f'could not process {package}', exc_info=True)
-                self.web.set_failed(local.base)
+                self.reporter.set_failed(local.base)
         self._clear_packages()
 
         return self.repo.repo_path
 
     def updates_aur(self, filter_packages: Iterable[str], no_vcs: bool) -> List[Package]:
+        '''
+        check AUR for updates
+        :param filter_packages: do not check every package just specified in the list
+        :param no_vcs: do not check VCS packages
+        :return: list of packages which are out-of-dated
+        '''
         result: List[Package] = []
 
         build_section = self.config.get_section_name('build', self.architecture)
@@ -174,26 +252,30 @@ class Repository:
 
             try:
                 remote = Package.load(local.base, self.pacman, self.aur_url)
-                if local.is_outdated(remote):
+                if local.is_outdated(remote, self.paths):
                     result.append(remote)
-                    self.web.set_pending(local.base)
+                    self.reporter.set_pending(local.base)
             except Exception:
-                self.web.set_failed(local.base)
+                self.reporter.set_failed(local.base)
                 self.logger.exception(f'could not load remote package {local.base}', exc_info=True)
                 continue
 
         return result
 
     def updates_manual(self) -> List[Package]:
+        '''
+        check for packages for which manual update has been requested
+        :return: list of packages which are out-of-dated
+        '''
         result: List[Package] = []
 
         for fn in os.listdir(self.paths.manual):
             try:
                 local = Package.load(os.path.join(self.paths.manual, fn), self.pacman, self.aur_url)
                 result.append(local)
-                self.web.set_unknown(local)
+                self.reporter.set_unknown(local)
             except Exception:
                 self.logger.exception(f'could not add package from {fn}', exc_info=True)
         self._clear_manual()
 
-        return result
+        return result

src/ahriman/core/sign/__init__.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify

src/ahriman/core/sign/gpg.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -29,8 +29,21 @@ from ahriman.models.sign_settings import SignSettings
 
 
 class GPG:
+    '''
+    gnupg wrapper
+    :ivar architecture: repository architecture
+    :ivar config: configuration instance
+    :ivar default_key: default PGP key ID to use
+    :ivar logger: class logger
+    :ivar target: list of targets to sign (repository, package etc)
+    '''
 
     def __init__(self, architecture: str, config: Configuration) -> None:
+        '''
+        default constructor
+        :param architecture: repository architecture
+        :param config: configuration instance
+        '''
         self.logger = logging.getLogger('build_details')
         self.config = config
         self.section = config.get_section_name('sign', architecture)
@@ -39,11 +52,20 @@ class GPG:
 
     @property
     def repository_sign_args(self) -> List[str]:
+        '''
+        :return: command line arguments for repo-add command to sign database
+        '''
         if SignSettings.SignRepository not in self.target:
             return []
         return ['--sign', '--key', self.default_key]
 
     def process(self, path: str, key: str) -> List[str]:
+        '''
+        gpg command wrapper
+        :param path: path to file to sign
+        :param key: PGP key ID
+        :return: list of generated files including original file
+        '''
         check_output(
             *self.sign_cmd(path, key),
             exception=BuildFailed(path),
@@ -52,18 +74,33 @@ class GPG:
         return [path, f'{path}.sig']
 
     def sign_cmd(self, path: str, key: str) -> List[str]:
-        cmd = ['gpg']
-        cmd.extend(['-u', key])
-        cmd.extend(['-b', path])
-        return cmd
+        '''
+        gpg command to run
+        :param path: path to file to sign
+        :param key: PGP key ID
+        :return: gpg command with all required arguments
+        '''
+        return ['gpg', '-u', key, '-b', path]
 
     def sign_package(self, path: str, base: str) -> List[str]:
+        '''
+        sign package if required by configuration
+        :param path: path to file to sign
+        :param base: package base required to check for key overrides
+        :return: list of generated files including original file
+        '''
         if SignSettings.SignPackages not in self.target:
             return [path]
         key = self.config.get(self.section, f'key_{base}', fallback=self.default_key)
         return self.process(path, key)
 
     def sign_repository(self, path: str) -> List[str]:
+        '''
+        sign repository if required by configuration
+        :note: more likely you just want to pass `repository_sign_args` to repo wrapper
+        :param path: path to repository database
+        :return: list of generated files including original file
+        '''
         if SignSettings.SignRepository not in self.target:
             return [path]
-        return self.process(path, self.default_key)
+        return self.process(path, self.default_key)

src/ahriman/core/tree.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -28,42 +28,33 @@ from ahriman.core.build_tools.task import Task
 from ahriman.models.package import Package
 
 
-class Tree:
-
-    def __init__(self) -> None:
-        self.packages: List[Leaf] = []
-
-    def levels(self) -> List[List[Package]]:
-        result: List[List[Package]] = []
-
-        unprocessed = [leaf for leaf in self.packages]
-        while unprocessed:
-            result.append([leaf.package for leaf in unprocessed if leaf.is_root(unprocessed)])
-            unprocessed = [leaf for leaf in unprocessed if not leaf.is_root(unprocessed)]
-
-        return result
-
-    def load(self, packages: Iterable[Package]) -> None:
-        for package in packages:
-            leaf = Leaf(package)
-            leaf.load_dependencies()
-            self.packages.append(leaf)
-
-
 class Leaf:
+    '''
+    tree leaf implementation
+    :ivar dependencies: list of package dependencies
+    :ivar package: leaf package properties
+    '''
 
     def __init__(self, package: Package) -> None:
+        '''
+        default constructor
+        :param package: package properties
+        '''
         self.package = package
         self.dependencies: Set[str] = set()
 
     @property
     def items(self) -> Iterable[str]:
+        '''
+        :return: packages containing in this leaf
+        '''
         return self.package.packages.keys()
 
     def is_root(self, packages: Iterable[Leaf]) -> bool:
         '''
-        :param packages:
-        :return: true if any of packages is dependency of the leaf, false otherwise
+        check if package depends on any other package from list of not
+        :param packages: list of known leaves
+        :return: True if any of packages is dependency of the leaf, False otherwise
         '''
         for leaf in packages:
             if self.dependencies.intersection(leaf.items):
@@ -71,9 +62,49 @@ class Leaf:
         return True
 
     def load_dependencies(self) -> None:
+        '''
+        load dependencies for the leaf
+        '''
         clone_dir = tempfile.mkdtemp()
         try:
             Task.fetch(clone_dir, self.package.git_url)
             self.dependencies = Package.dependencies(clone_dir)
         finally:
-            shutil.rmtree(clone_dir, ignore_errors=True)
+            shutil.rmtree(clone_dir, ignore_errors=True)
+
+
+class Tree:
+    '''
+    dependency tree implementation
+    :ivar leaves: list of tree leaves
+    '''
+
+    def __init__(self) -> None:
+        '''
+        default constructor
+        '''
+        self.leaves: List[Leaf] = []
+
+    def levels(self) -> List[List[Package]]:
+        '''
+        get build levels starting from the packages which do not require any other package to build
+        :return: list of packages lists
+        '''
+        result: List[List[Package]] = []
+
+        unprocessed = [leaf for leaf in self.leaves]
+        while unprocessed:
+            result.append([leaf.package for leaf in unprocessed if leaf.is_root(unprocessed)])
+            unprocessed = [leaf for leaf in unprocessed if not leaf.is_root(unprocessed)]
+
+        return result
+
+    def load(self, packages: Iterable[Package]) -> None:
+        '''
+        load tree from packages
+        :param packages: packages list
+        '''
+        for package in packages:
+            leaf = Leaf(package)
+            leaf.load_dependencies()
+            self.leaves.append(leaf)

src/ahriman/core/upload/__init__.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify

src/ahriman/core/upload/rsync.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -23,13 +23,26 @@ from ahriman.core.util import check_output
 
 
 class Rsync(Uploader):
+    '''
+    rsync wrapper
+    :ivar remote: remote address to sync
+    '''
 
     def __init__(self, architecture: str, config: Configuration) -> None:
+        '''
+        default constructor
+        :param architecture: repository architecture
+        :param config: configuration instance
+        '''
         Uploader.__init__(self, architecture, config)
         section = config.get_section_name('rsync', architecture)
         self.remote = config.get(section, 'remote')
 
     def sync(self, path: str) -> None:
+        '''
+        sync data to remote server
+        :param path: local path to sync
+        '''
         check_output('rsync', '--archive', '--verbose', '--compress', '--partial', '--progress', '--delete', path, self.remote,
                      exception=None,
                      logger=self.logger)

src/ahriman/core/upload/s3.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -23,13 +23,26 @@ from ahriman.core.util import check_output
 
 
 class S3(Uploader):
+    '''
+    aws-cli wrapper
+    :ivar bucket: full bucket name
+    '''
 
     def __init__(self, architecture: str, config: Configuration) -> None:
+        '''
+        default constructor
+        :param architecture: repository architecture
+        :param config: configuration instance
+        '''
         Uploader.__init__(self, architecture, config)
         section = config.get_section_name('s3', architecture)
         self.bucket = config.get(section, 'bucket')
 
     def sync(self, path: str) -> None:
+        '''
+        sync data to remote server
+        :param path: local path to sync
+        '''
         # TODO rewrite to boto, but it is bullshit
         check_output('aws', 's3', 'sync', '--delete', path, self.bucket,
                      exception=None,

src/ahriman/core/upload/uploader.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -25,14 +25,32 @@ from ahriman.models.upload_settings import UploadSettings
 
 
 class Uploader:
+    '''
+    base remote sync class
+    :ivar architecture: repository architecture
+    :ivar config: configuration instance
+    :ivar logger: application logger
+    '''
 
     def __init__(self, architecture: str, config: Configuration) -> None:
+        '''
+        default constructor
+        :param architecture: repository architecture
+        :param config: configuration instance
+        '''
         self.logger = logging.getLogger('builder')
         self.architecture = architecture
         self.config = config
 
     @staticmethod
     def run(architecture: str, config: Configuration, target: str, path: str) -> None:
+        '''
+        run remote sync
+        :param architecture: repository architecture
+        :param config: configuration instance
+        :param target: target to run sync (e.g. s3)
+        :param path: local path to sync
+        '''
         provider = UploadSettings.from_option(target)
         if provider == UploadSettings.Rsync:
             from ahriman.core.upload.rsync import Rsync
@@ -50,4 +68,8 @@ class Uploader:
             raise SyncFailed()
 
     def sync(self, path: str) -> None:
+        '''
+        sync data to remote server
+        :param path: local path to sync
+        '''
         pass

src/ahriman/core/util.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -17,15 +17,27 @@
 # You should have received a copy of the GNU General Public License
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
+import datetime
 import subprocess
 
 from logging import Logger
 from typing import Optional
 
+from ahriman.core.exceptions import InvalidOption
+
 
 def check_output(*args: str, exception: Optional[Exception],
                  cwd: Optional[str] = None, stderr: int = subprocess.STDOUT,
                  logger: Optional[Logger] = None) -> str:
+    '''
+    subprocess wrapper
+    :param args: command line arguments
+    :param exception: exception which has to be reraised instead of default subprocess exception
+    :param cwd: current working directory
+    :param stderr: standard error output mode
+    :param logger: logger to log command result if required
+    :return: command output
+    '''
     try:
         result = subprocess.check_output(args, cwd=cwd, stderr=stderr).decode('utf8').strip()
         if logger is not None:
@@ -40,4 +52,43 @@ def check_output(*args: str, exception: Optional[Exception],
 
 
 def package_like(filename: str) -> bool:
+    '''
+    check if file looks like package
+    :param filename: name of file to check
+    :return: True in case if name contains `.pkg.` and not signature, False otherwise
+    '''
     return '.pkg.' in filename and not filename.endswith('.sig')
+
+
+def pretty_datetime(timestamp: Optional[int]) -> str:
+    '''
+    convert datetime object to string
+    :param timestamp: datetime to convert
+    :return: pretty printable datetime as string
+    '''
+    return '' if timestamp is None else datetime.datetime.utcfromtimestamp(timestamp).strftime('%Y-%m-%d %H:%M:%S')
+
+
+def pretty_size(size: Optional[float], level: int = 0) -> str:
+    '''
+    convert size to string
+    :param size: size to convert
+    :param level: represents current units, 0 is B, 1 is KiB etc
+    :return: pretty printable size as string
+    '''
+    def str_level() -> str:
+        if level == 0:
+            return 'B'
+        elif level == 1:
+            return 'KiB'
+        elif level == 2:
+            return 'MiB'
+        elif level == 3:
+            return 'GiB'
+        raise InvalidOption(level)  # I hope it will not be more than 1024 GiB
+
+    if size is None:
+        return ''
+    elif size < 1024:
+        return f'{round(size, 2)} {str_level()}'
+    return pretty_size(size / 1024, level + 1)

src/ahriman/core/watcher/__init__.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify

src/ahriman/core/watcher/client.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -19,98 +19,94 @@
 #
 from __future__ import annotations
 
-import logging
-
-from typing import Any, Dict, Set
-
 from ahriman.core.configuration import Configuration
 from ahriman.models.build_status import BuildStatusEnum
 from ahriman.models.package import Package
 
 
 class Client:
+    '''
+    base build status reporter client
+    '''
 
     def add(self, package: Package, status: BuildStatusEnum) -> None:
+        '''
+        add new package with status
+        :param package: package properties
+        :param status: current package build status
+        '''
         pass
 
-    def remove(self, base: str, packages: Set[str]) -> None:
+    def remove(self, base: str) -> None:
+        '''
+        remove packages from watcher
+        :param base: basename to remove
+        '''
         pass
 
     def update(self, base: str, status: BuildStatusEnum) -> None:
+        '''
+        update package build status. Unlike `add` it does not update package properties
+        :param base: package base to update
+        :param status: current package build status
+        '''
+        pass
+
+    def update_self(self, status: BuildStatusEnum) -> None:
+        '''
+        update ahriman status itself
+        :param status: current ahriman status
+        '''
         pass
 
     def set_building(self, base: str) -> None:
+        '''
+        set package status to building
+        :param base: package base to update
+        '''
         return self.update(base, BuildStatusEnum.Building)
 
     def set_failed(self, base: str) -> None:
+        '''
+        set package status to failed
+        :param base: package base to update
+        '''
         return self.update(base, BuildStatusEnum.Failed)
 
     def set_pending(self, base: str) -> None:
+        '''
+        set package status to pending
+        :param base: package base to update
+        '''
         return self.update(base, BuildStatusEnum.Pending)
 
     def set_success(self, package: Package) -> None:
+        '''
+        set package status to success
+        :param package: current package properties
+        '''
         return self.add(package, BuildStatusEnum.Success)
 
     def set_unknown(self, package: Package) -> None:
+        '''
+        set package status to unknown
+        :param package: current package properties
+        '''
         return self.add(package, BuildStatusEnum.Unknown)
 
     @staticmethod
     def load(architecture: str, config: Configuration) -> Client:
+        '''
+        load client from settings
+        :param architecture: repository architecture
+        :param config: configuration instance
+        :return: client according to current settings
+        '''
         section = config.get_section_name('web', architecture)
         host = config.get(section, 'host', fallback=None)
         port = config.getint(section, 'port', fallback=None)
         if host is None or port is None:
             return Client()
+
+        from ahriman.core.watcher.web_client import WebClient
         return WebClient(host, port)
-
-
-class WebClient(Client):
-
-    def __init__(self, host: str, port: int) -> None:
-        self.logger = logging.getLogger('http')
-        self.host = host
-        self.port = port
-
-    def _url(self, base: str) -> str:
-        return f'http://{self.host}:{self.port}/api/v1/packages/{base}'
-
-    def add(self, package: Package, status: BuildStatusEnum) -> None:
-        import requests
-
-        payload: Dict[str, Any] = {
-            'status': status.value,
-            'package': {
-                'base': package.base,
-                'packages': [p for p in package.packages],
-                'version': package.version,
-                'aur_url': package.aur_url
-            }
-        }
-
-        try:
-            response = requests.post(self._url(package.base), json=payload)
-            response.raise_for_status()
-        except:
-            self.logger.exception(f'could not add {package.base}', exc_info=True)
-
-    def remove(self, base: str, packages: Set[str]) -> None:
-        if not packages:
-            return
-        import requests
-
-        try:
-            response = requests.delete(self._url(base))
-            response.raise_for_status()
-        except:
-            self.logger.exception(f'could not delete {base}', exc_info=True)
-
-    def update(self, base: str, status: BuildStatusEnum) -> None:
-        import requests
-
-        payload: Dict[str, Any] = {'status': status.value}
-
-        try:
-            response = requests.post(self._url(base), json=payload)
-            response.raise_for_status()
-        except:
-            self.logger.exception(f'could not update {base}', exc_info=True)

src/ahriman/core/watcher/watcher.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -26,18 +26,36 @@ from ahriman.models.package import Package
 
 
 class Watcher:
+    '''
+    package status watcher
+    :ivar architecture: repository architecture
+    :ivar known: list of known packages. For the most cases `packages` should be used instead
+    :ivar repository: repository object
+    '''
 
     def __init__(self, architecture: str, config: Configuration) -> None:
+        '''
+        default constructor
+        :param architecture: repository architecture
+        :param config: configuration instance
+        '''
         self.architecture = architecture
         self.repository = Repository(architecture, config)
 
         self.known: Dict[str, Tuple[Package, BuildStatus]] = {}
+        self.status = BuildStatus()
 
     @property
     def packages(self) -> List[Tuple[Package, BuildStatus]]:
+        '''
+        :return: list of packages together with their statuses
+        '''
         return [pair for pair in self.known.values()]
 
     def load(self) -> None:
+        '''
+        load packages from local repository. In case if last status is known, it will use it
+        '''
         for package in self.repository.packages():
             # get status of build or assign unknown
             current = self.known.get(package.base)
@@ -48,10 +66,27 @@ class Watcher:
             self.known[package.base] = (package, status)
 
     def remove(self, base: str) -> None:
+        '''
+        remove package base from known list if any
+        :param base: package base
+        '''
         self.known.pop(base, None)
 
     def update(self, base: str, status: BuildStatusEnum, package: Optional[Package]) -> None:
+        '''
+        update package status and description
+        :param base: package base to update
+        :param status: new build status
+        :param package: optional new package description. In case if not set current properties will be used
+        '''
         if package is None:
             package, _ = self.known[base]
         full_status = BuildStatus(status)
         self.known[base] = (package, full_status)
+
+    def update_self(self, status: BuildStatusEnum) -> None:
+        '''
+        update service status
+        :param status: new service status
+        '''
+        self.status = BuildStatus(status)

src/ahriman/core/watcher/web_client.py

@@ -0,0 +1,117 @@
+#
+# Copyright (c) 2021 Evgenii Alekseev.
+#
+# This file is part of ahriman
+# (see https://github.com/arcan1s/ahriman).
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+import logging
+import requests
+
+from dataclasses import asdict
+from typing import Any, Dict
+
+from ahriman.core.watcher.client import Client
+from ahriman.models.build_status import BuildStatusEnum
+from ahriman.models.package import Package
+
+
+class WebClient(Client):
+    '''
+    build status reporter web client
+    :ivar host: host of web service
+    :ivar logger: class logger
+    :ivar port: port of web service
+    '''
+
+    def __init__(self, host: str, port: int) -> None:
+        '''
+        default constructor
+        :param host: host of web service
+        :param port: port of web service
+        '''
+        self.logger = logging.getLogger('http')
+        self.host = host
+        self.port = port
+
+    def _ahriman_url(self) -> str:
+        '''
+        url generator
+        :return: full url for web service for ahriman service itself
+        '''
+        return f'http://{self.host}:{self.port}/api/v1/ahriman'
+
+    def _package_url(self, base: str) -> str:
+        '''
+        url generator
+        :param base: package base to generate url
+        :return: full url of web service for specific package base
+        '''
+        return f'http://{self.host}:{self.port}/api/v1/packages/{base}'
+
+    def add(self, package: Package, status: BuildStatusEnum) -> None:
+        '''
+        add new package with status
+        :param package: package properties
+        :param status: current package build status
+        '''
+        payload: Dict[str, Any] = {
+            'status': status.value,
+            'package': asdict(package)
+        }
+
+        try:
+            response = requests.post(self._package_url(package.base), json=payload)
+            response.raise_for_status()
+        except Exception:
+            self.logger.exception(f'could not add {package.base}', exc_info=True)
+
+    def remove(self, base: str) -> None:
+        '''
+        remove packages from watcher
+        :param base: basename to remove
+        '''
+        try:
+            response = requests.delete(self._package_url(base))
+            response.raise_for_status()
+        except Exception:
+            self.logger.exception(f'could not delete {base}', exc_info=True)
+
+    def update(self, base: str, status: BuildStatusEnum) -> None:
+        '''
+        update package build status. Unlike `add` it does not update package properties
+        :param base: package base to update
+        :param status: current package build status
+        '''
+        payload: Dict[str, Any] = {'status': status.value}
+
+        try:
+            response = requests.post(self._package_url(base), json=payload)
+            response.raise_for_status()
+        except Exception:
+            self.logger.exception(f'could not update {base}', exc_info=True)
+
+    def update_self(self, status: BuildStatusEnum) -> None:
+        '''
+        update ahriman status itself
+        :param status: current ahriman status
+        '''
+        payload: Dict[str, Any] = {'status': status.value}
+
+        try:
+            response = requests.post(self._ahriman_url(), json=payload)
+            response.raise_for_status()
+        except Exception:
+            self.logger.exception(f'could not update service status', exc_info=True)

src/ahriman/models/__init__.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify

src/ahriman/models/build_status.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -24,20 +24,50 @@ from typing import Optional, Union
 
 
 class BuildStatusEnum(Enum):
+    '''
+    build status enumeration
+    :cvar Unknown: build status is unknown
+    :cvar Pending: package is out-of-dated and will be built soon
+    :cvar Building: package is building right now
+    :cvar Failed: package build failed
+    :cvar Success: package has been built without errors
+    '''
+
     Unknown = 'unknown'
     Pending = 'pending'
     Building = 'building'
     Failed = 'failed'
     Success = 'success'
 
+    def badges_color(self) -> str:
+        '''
+        convert itself to shield.io badges color
+        :return: shields.io color
+        '''
+        if self == BuildStatusEnum.Pending:
+            return 'yellow'
+        elif self == BuildStatusEnum.Building:
+            return 'yellow'
+        elif self == BuildStatusEnum.Failed:
+            return 'critical'
+        elif self == BuildStatusEnum.Success:
+            return 'success'
+        return 'inactive'
+
 
 class BuildStatus:
+    '''
+    build status holder
+    :ivar status: build status
+    :ivar _timestamp: build status update time
+    '''
 
     def __init__(self, status: Union[BuildStatusEnum, str, None] = None,
-                 timestamp: Optional[datetime.datetime] = None) -> None:
+                 timestamp: Optional[int] = None) -> None:
+        '''
+        default constructor
+        :param status: current build status if known. `BuildStatusEnum.Unknown` will be used if not set
+        :param timestamp: build status timestamp. Current timestamp will be used if not set
+        '''
         self.status = BuildStatusEnum(status) if status else BuildStatusEnum.Unknown
-        self._timestamp = timestamp or datetime.datetime.utcnow()
-
-    @property
-    def timestamp(self) -> str:
-        return self._timestamp.strftime('%Y-%m-%d %H:%M:%S')
+        self.timestamp = timestamp or int(datetime.datetime.utcnow().timestamp())

src/ahriman/models/package.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -19,10 +19,10 @@
 #
 from __future__ import annotations
 
+import logging
+
 import aur  # type: ignore
 import os
-import shutil
-import tempfile
 
 from dataclasses import dataclass
 from pyalpm import vercmp  # type: ignore
@@ -32,77 +32,124 @@ from typing import Dict, List, Optional, Set, Type
 from ahriman.core.alpm.pacman import Pacman
 from ahriman.core.exceptions import InvalidPackageInfo
 from ahriman.core.util import check_output
+from ahriman.models.package_desciption import PackageDescription
+from ahriman.models.repository_paths import RepositoryPaths
 
 
 @dataclass
 class Package:
+    '''
+    package properties representation
+    :ivar aurl_url: AUR root url
+    :ivar base: package base name
+    :ivar packages: map of package names to their properties. Filled only on load from archive
+    :ivar version: package full version
+    '''
+
     base: str
     version: str
     aur_url: str
-    packages: Dict[str, str]  # map of package name to archive name
+    packages: Dict[str, PackageDescription]
 
     @property
     def git_url(self) -> str:
+        '''
+        :return: package git url to clone
+        '''
         return f'{self.aur_url}/{self.base}.git'
 
     @property
     def is_vcs(self) -> bool:
+        '''
+        :return: True in case if package base looks like VCS package and false otherwise
+        '''
         return self.base.endswith('-bzr') \
-               or self.base.endswith('-csv')\
-               or self.base.endswith('-darcs')\
-               or self.base.endswith('-git')\
-               or self.base.endswith('-hg')\
-               or self.base.endswith('-svn')
+            or self.base.endswith('-csv')\
+            or self.base.endswith('-darcs')\
+            or self.base.endswith('-git')\
+            or self.base.endswith('-hg')\
+            or self.base.endswith('-svn')
 
     @property
     def web_url(self) -> str:
+        '''
+        :return: package AUR url
+        '''
         return f'{self.aur_url}/packages/{self.base}'
 
-    # additional method to handle vcs versions
-    def actual_version(self) -> str:
+    def actual_version(self, paths: RepositoryPaths) -> str:
+        '''
+        additional method to handle VCS package versions
+        :param paths: repository paths instance
+        :return: package version if package is not VCS and current version according to VCS otherwise
+        '''
         if not self.is_vcs:
             return self.version
 
         from ahriman.core.build_tools.task import Task
-        clone_dir = tempfile.mkdtemp()
-        try:
-            Task.fetch(clone_dir, self.git_url)
-            # update pkgver first
-            check_output('makepkg', '--nodeps', '--nobuild',
-                         exception=None, cwd=clone_dir)
-            # generate new .SRCINFO and put it to parser
-            src_info_source = check_output('makepkg', '--printsrcinfo',
-                                           exception=None, cwd=clone_dir)
-            src_info, errors = parse_srcinfo(src_info_source)
-            if errors:
-                raise InvalidPackageInfo(errors)
-            return self.full_version(src_info.get('epoch'), src_info['pkgver'], src_info['pkgrel'])
-        finally:
-            shutil.rmtree(clone_dir, ignore_errors=True)
+
+        clone_dir = os.path.join(paths.cache, self.base)
+        logger = logging.getLogger('build_details')
+        Task.fetch(clone_dir, self.git_url)
+
+        # update pkgver first
+        check_output('makepkg', '--nodeps', '--nobuild', exception=None, cwd=clone_dir, logger=logger)
+        # generate new .SRCINFO and put it to parser
+        src_info_source = check_output('makepkg', '--printsrcinfo', exception=None, cwd=clone_dir, logger=logger)
+        src_info, errors = parse_srcinfo(src_info_source)
+        if errors:
+            raise InvalidPackageInfo(errors)
+
+        return self.full_version(src_info.get('epoch'), src_info['pkgver'], src_info['pkgrel'])
 
     @classmethod
     def from_archive(cls: Type[Package], path: str, pacman: Pacman, aur_url: str) -> Package:
+        '''
+        construct package properties from package archive
+        :param path: path to package archive
+        :param pacman: alpm wrapper instance
+        :param aur_url: AUR root url
+        :return: package properties
+        '''
         package = pacman.handle.load_pkg(path)
-        return cls(package.base, package.version, aur_url, {package.name: os.path.basename(path)})
+        properties = PackageDescription(package.size, package.builddate, os.path.basename(path), package.isize)
+        return cls(package.base, package.version, aur_url, {package.name: properties})
 
     @classmethod
-    def from_aur(cls: Type[Package], name: str, aur_url: str)-> Package:
+    def from_aur(cls: Type[Package], name: str, aur_url: str) -> Package:
+        '''
+        construct package properties from AUR page
+        :param name: package name (either base or normal name)
+        :param aur_url: AUR root url
+        :return: package properties
+        '''
         package = aur.info(name)
-        return cls(package.package_base, package.version, aur_url, {package.name: ''})
+        return cls(package.package_base, package.version, aur_url, {package.name: PackageDescription()})
 
     @classmethod
     def from_build(cls: Type[Package], path: str, aur_url: str) -> Package:
+        '''
+        construct package properties from sources directory
+        :param path: path to package sources directory
+        :param aur_url: AUR root url
+        :return: package properties
+        '''
         with open(os.path.join(path, '.SRCINFO')) as fn:
             src_info, errors = parse_srcinfo(fn.read())
         if errors:
             raise InvalidPackageInfo(errors)
-        packages = {key: '' for key in src_info['packages'].keys()}
+        packages = {key: PackageDescription() for key in src_info['packages'].keys()}
         version = cls.full_version(src_info.get('epoch'), src_info['pkgver'], src_info['pkgrel'])
 
         return cls(src_info['pkgbase'], version, aur_url, packages)
 
     @staticmethod
     def dependencies(path: str) -> Set[str]:
+        '''
+        load dependencies from package sources
+        :param path: path to package sources directory
+        :return: list of package dependencies including makedepends array, but excluding packages from this base
+        '''
         with open(os.path.join(path, '.SRCINFO')) as fn:
             src_info, errors = parse_srcinfo(fn.read())
         if errors:
@@ -118,11 +165,25 @@ class Package:
 
     @staticmethod
     def full_version(epoch: Optional[str], pkgver: str, pkgrel: str) -> str:
+        '''
+        generate full version from components
+        :param epoch: package epoch if any
+        :param pkgver: package version
+        :param pkgrel: package release version (archlinux specific)
+        :return: generated version
+        '''
         prefix = f'{epoch}:' if epoch else ''
         return f'{prefix}{pkgver}-{pkgrel}'
 
     @staticmethod
     def load(path: str, pacman: Pacman, aur_url: str) -> Package:
+        '''
+        package constructor from available sources
+        :param path: one of path to sources directory, path to archive or package name/base
+        :param pacman: alpm wrapper instance (required to load from archive)
+        :param aur_url: AUR root url
+        :return: package properties
+        '''
         try:
             if os.path.isdir(path):
                 package: Package = Package.from_build(path, aur_url)
@@ -136,7 +197,13 @@ class Package:
         except Exception as e:
             raise InvalidPackageInfo(str(e))
 
-    def is_outdated(self, remote: Package) -> bool:
-        remote_version = remote.actual_version()  # either normal version or updated VCS
+    def is_outdated(self, remote: Package, paths: RepositoryPaths) -> bool:
+        '''
+        check if package is out-of-dated
+        :param remote: package properties from remote source
+        :param paths: repository paths instance. Required for VCS packages cache
+        :return: True if the package is out-of-dated and False otherwise
+        '''
+        remote_version = remote.actual_version(paths)  # either normal version or updated VCS
         result: int = vercmp(self.version, remote_version)
         return result < 0

src/ahriman/models/package_desciption.py

@@ -0,0 +1,37 @@
+#
+# Copyright (c) 2021 Evgenii Alekseev.
+#
+# This file is part of ahriman
+# (see https://github.com/arcan1s/ahriman).
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+from dataclasses import dataclass
+from typing import Optional
+
+
+@dataclass
+class PackageDescription:
+    '''
+    package specific properties
+    :ivar archive_size: package archive size
+    :ivar build_date: package build date
+    :ivar filename: package archive name
+    :ivar installed_size: package installed size
+    '''
+
+    archive_size: Optional[int] = None
+    build_date: Optional[int] = None
+    filename: Optional[str] = None
+    installed_size: Optional[int] = None

src/ahriman/models/report_settings.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -25,10 +25,20 @@ from ahriman.core.exceptions import InvalidOption
 
 
 class ReportSettings(Enum):
+    '''
+    report targets enumeration
+    :cvar HTML: html report generation
+    '''
+
     HTML = auto()
 
     @staticmethod
     def from_option(value: str) -> ReportSettings:
+        '''
+        construct value from configuration
+        :param value: configuration value
+        :return: parsed value
+        '''
         if value.lower() in ('html',):
             return ReportSettings.HTML
         raise InvalidOption(value)

src/ahriman/models/repository_paths.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -24,14 +24,28 @@ from dataclasses import dataclass
 
 @dataclass
 class RepositoryPaths:
+    '''
+    repository paths holder. For the most operations with paths you want to use this object
+    :ivar root: repository root (i.e. ahriman home)
+    :ivar architecture: repository architecture
+    '''
+
     root: str
     architecture: str
 
+    @property
+    def cache(self) -> str:
+        '''
+        :return: directory for packages cache (mainly used for VCS packages)
+        '''
+        return os.path.join(self.root, 'cache')
+
     @property
     def chroot(self) -> str:
         '''
         :return: directory for devtools chroot
         '''
+        # for the chroot directory devtools will create own tree and we don't have to specify architecture here
         return os.path.join(self.root, 'chroot')
 
     @property
@@ -39,14 +53,14 @@ class RepositoryPaths:
         '''
         :return: directory for manual updates (i.e. from add command)
         '''
-        return os.path.join(self.root, 'manual')
+        return os.path.join(self.root, 'manual', self.architecture)
 
     @property
     def packages(self) -> str:
         '''
         :return: directory for built packages
         '''
-        return os.path.join(self.root, 'packages')
+        return os.path.join(self.root, 'packages', self.architecture)
 
     @property
     def repository(self) -> str:
@@ -60,11 +74,15 @@ class RepositoryPaths:
         '''
         :return: directory for downloaded PKGBUILDs for current build
         '''
-        return os.path.join(self.root, 'sources')
+        return os.path.join(self.root, 'sources', self.architecture)
 
     def create_tree(self) -> None:
+        '''
+        create ahriman working tree
+        '''
+        os.makedirs(self.cache, mode=0o755, exist_ok=True)
         os.makedirs(self.chroot, mode=0o755, exist_ok=True)
         os.makedirs(self.manual, mode=0o755, exist_ok=True)
         os.makedirs(self.packages, mode=0o755, exist_ok=True)
         os.makedirs(self.repository, mode=0o755, exist_ok=True)
-        os.makedirs(self.sources, mode=0o755, exist_ok=True)
+        os.makedirs(self.sources, mode=0o755, exist_ok=True)

src/ahriman/models/sign_settings.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -25,13 +25,24 @@ from ahriman.core.exceptions import InvalidOption
 
 
 class SignSettings(Enum):
+    '''
+    sign targets enumeration
+    :cvar SignPackages: sign each package
+    :cvar SignRepository: sign repository database file
+    '''
+
     SignPackages = auto()
     SignRepository = auto()
 
     @staticmethod
     def from_option(value: str) -> SignSettings:
+        '''
+        construct value from configuration
+        :param value: configuration value
+        :return: parsed value
+        '''
         if value.lower() in ('package', 'packages', 'sign-package'):
             return SignSettings.SignPackages
         elif value.lower() in ('repository', 'sign-repository'):
             return SignSettings.SignRepository
-        raise InvalidOption(value)
+        raise InvalidOption(value)

src/ahriman/models/upload_settings.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -25,11 +25,22 @@ from ahriman.core.exceptions import InvalidOption
 
 
 class UploadSettings(Enum):
+    '''
+    remote synchronization targets enumeration
+    :cvar Rsync: sync via rsync
+    :cvar S3: sync to Amazon S3
+    '''
+
     Rsync = auto()
     S3 = auto()
 
     @staticmethod
     def from_option(value: str) -> UploadSettings:
+        '''
+        construct value from configuration
+        :param value: configuration value
+        :return: parsed value
+        '''
         if value.lower() in ('rsync',):
             return UploadSettings.Rsync
         elif value.lower() in ('s3',):

src/ahriman/version.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -17,4 +17,4 @@
 # You should have received a copy of the GNU General Public License
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
-__version__ = '0.11.7'
+__version__ = '0.14.0'

src/ahriman/web/__init__.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify

src/ahriman/web/middlewares/__init__.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify

src/ahriman/web/middlewares/exception_handler.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -28,6 +28,11 @@ HandlerType = Callable[[Request], Awaitable[StreamResponse]]
 
 
 def exception_handler(logger: Logger) -> Callable[[Request, HandlerType], Awaitable[StreamResponse]]:
+    '''
+    exception handler middleware. Just log any exception (except for client ones)
+    :param logger: class logger
+    :return: built middleware
+    '''
     @middleware
     async def handle(request: Request, handler: HandlerType) -> StreamResponse:
         try:

src/ahriman/web/routes.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -19,16 +19,36 @@
 #
 from aiohttp.web import Application
 
+from ahriman.web.views.ahriman import AhrimanView
 from ahriman.web.views.index import IndexView
 from ahriman.web.views.package import PackageView
 from ahriman.web.views.packages import PackagesView
 
 
-def setup_routes(app: Application) -> None:
-    app.router.add_get('/', IndexView)
-    app.router.add_get('/index.html', IndexView)
+def setup_routes(application: Application) -> None:
+    '''
+    setup all defined routes
 
-    app.router.add_post('/api/v1/packages', PackagesView)
+    Available routes are:
 
-    app.router.add_delete('/api/v1/packages/{package}', PackageView)
-    app.router.add_post('/api/v1/packages/{package}', PackageView)
+        GET /                           get build status page
+        GET /index.html                 same as above
+
+        POST /api/v1/ahriman            update service status
+
+        POST /api/v1/packages           force update every package from repository
+
+        POST /api/v1/package/:base      update package base status
+        DELETE /api/v1/package/:base    delete package base from status page
+
+    :param application: web application instance
+    '''
+    application.router.add_get('/', IndexView)
+    application.router.add_get('/index.html', IndexView)
+
+    application.router.add_post('/api/v1/ahriman', AhrimanView)
+
+    application.router.add_post('/api/v1/packages', PackagesView)
+
+    application.router.add_delete('/api/v1/packages/{package}', PackageView)
+    application.router.add_post('/api/v1/packages/{package}', PackageView)

src/ahriman/web/views/__init__.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify

src/ahriman/web/views/ahriman.py

@@ -0,0 +1,51 @@
+#
+# Copyright (c) 2021 Evgenii Alekseev.
+#
+# This file is part of ahriman
+# (see https://github.com/arcan1s/ahriman).
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+#
+from aiohttp.web import HTTPBadRequest, HTTPOk, Response
+
+from ahriman.models.build_status import BuildStatusEnum
+from ahriman.web.views.base import BaseView
+
+
+class AhrimanView(BaseView):
+    '''
+    service status web view
+    '''
+
+    async def post(self) -> Response:
+        '''
+        update service status
+
+        JSON body must be supplied, the following model is used:
+        {
+            "status": "unknown",   # service status string, must be valid `BuildStatusEnum`
+        }
+
+        :return: 200 on success
+        '''
+        data = await self.request.json()
+
+        try:
+            status = BuildStatusEnum(data['status'])
+        except Exception as e:
+            raise HTTPBadRequest(text=str(e))
+
+        self.service.update_self(status)
+
+        return HTTPOk()

src/ahriman/web/views/base.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -22,10 +22,15 @@ from aiohttp.web import View
 from ahriman.core.watcher.watcher import Watcher
 
 
-# special class to make it typed
 class BaseView(View):
+    '''
+    base web view to make things typed
+    '''
 
     @property
     def service(self) -> Watcher:
+        '''
+        :return: build status watcher instance
+        '''
         watcher: Watcher = self.request.app['watcher']
         return watcher

src/ahriman/web/views/index.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -23,28 +23,51 @@ from typing import Any, Dict
 
 import ahriman.version as version
 
+from ahriman.core.util import pretty_datetime
 from ahriman.web.views.base import BaseView
 
 
 class IndexView(BaseView):
+    '''
+    root view
+
+    It uses jinja2 templates for report generation, the following variables are allowed:
+
+        architecture - repository architecture, string, required
+        packages - sorted list of packages properties: base, packages (sorted list), status,
+                   timestamp, version, web_url. Required
+        repository - repository name, string, required
+        service - service status properties: status, status_color, timestamp. Required
+        version - ahriman version, string, required
+    '''
 
     @aiohttp_jinja2.template("build-status.jinja2")  # type: ignore
     async def get(self) -> Dict[str, Any]:
+        '''
+        process get request. No parameters supported here
+        :return: parameters for jinja template
+        '''
         # some magic to make it jinja-friendly
         packages = [
             {
                 'base': package.base,
                 'packages': [p for p in sorted(package.packages)],
                 'status': status.status.value,
-                'timestamp': status.timestamp,
+                'timestamp': pretty_datetime(status.timestamp),
                 'version': package.version,
                 'web_url': package.web_url
             } for package, status in sorted(self.service.packages, key=lambda item: item[0].base)
         ]
+        service = {
+            'status': self.service.status.status.value,
+            'status_color': self.service.status.status.badges_color(),
+            'timestamp': pretty_datetime(self.service.status.timestamp)
+        }
 
         return {
             'architecture': self.service.architecture,
             'packages': packages,
             'repository': self.service.repository.name,
+            'service': service,
             'version': version.__version__,
-        }
+        }

src/ahriman/web/views/package.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -17,7 +17,7 @@
 # You should have received a copy of the GNU General Public License
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
-from aiohttp.web import HTTPOk, Response
+from aiohttp.web import HTTPBadRequest, HTTPOk, Response
 
 from ahriman.models.build_status import BuildStatusEnum
 from ahriman.models.package import Package
@@ -25,19 +25,45 @@ from ahriman.web.views.base import BaseView
 
 
 class PackageView(BaseView):
+    '''
+    package base specific web view
+    '''
 
     async def delete(self) -> Response:
+        '''
+        delete package base from status page
+        :return: 200 on success
+        '''
         base = self.request.match_info['package']
         self.service.remove(base)
 
         return HTTPOk()
 
     async def post(self) -> Response:
+        '''
+        update package build status
+
+        JSON body must be supplied, the following model is used:
+        {
+            "status": "unknown",   # package build status string, must be valid `BuildStatusEnum`
+            "package": {}  # package body (use `dataclasses.asdict` to generate one), optional.
+                           # Must be supplied in case if package base is unknown
+        }
+
+        :return: 200 on success
+        '''
         base = self.request.match_info['package']
         data = await self.request.json()
 
-        package = Package(**data['package']) if 'package' in data else None
-        status = BuildStatusEnum(data['status'])
-        self.service.update(base, status, package)
+        try:
+            package = Package(**data['package']) if 'package' in data else None
+            status = BuildStatusEnum(data['status'])
+        except Exception as e:
+            raise HTTPBadRequest(text=str(e))
+
+        try:
+            self.service.update(base, status, package)
+        except KeyError:
+            raise HTTPBadRequest(text=f'Package {base} is unknown, but no package body set')
 
         return HTTPOk()

src/ahriman/web/views/packages.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -23,8 +23,15 @@ from ahriman.web.views.base import BaseView
 
 
 class PackagesView(BaseView):
+    '''
+    global watcher view
+    '''
 
     async def post(self) -> Response:
+        '''
+        reload all packages from repository. No parameters supported here
+        :return: 200 on success
+        '''
         self.service.load()
 
         return HTTPOk()

src/ahriman/web/web.py

@@ -1,7 +1,7 @@
 #
 # Copyright (c) 2021 Evgenii Alekseev.
 #
-# This file is part of ahriman 
+# This file is part of ahriman
 # (see https://github.com/arcan1s/ahriman).
 #
 # This program is free software: you can redistribute it and/or modify
@@ -30,46 +30,66 @@ from ahriman.web.middlewares.exception_handler import exception_handler
 from ahriman.web.routes import setup_routes
 
 
-async def on_shutdown(app: web.Application) -> None:
-    app.logger.warning('server terminated')
+async def on_shutdown(application: web.Application) -> None:
+    '''
+    web application shutdown handler
+    :param application: web application instance
+    '''
+    application.logger.warning('server terminated')
 
 
-async def on_startup(app: web.Application) -> None:
-    app.logger.info('server started')
+async def on_startup(application: web.Application) -> None:
+    '''
+    web application start handler
+    :param application: web application instance
+    '''
+    application.logger.info('server started')
     try:
-        app['watcher'].load()
+        application['watcher'].load()
     except Exception:
-        app.logger.exception('could not load packages', exc_info=True)
+        application.logger.exception('could not load packages', exc_info=True)
         raise InitializeException()
 
 
-def run_server(app: web.Application, architecture: str) -> None:
-    app.logger.info('start server')
+def run_server(application: web.Application, architecture: str) -> None:
+    '''
+    run web application
+    :param application: web application instance
+    :param architecture: repository architecture
+    '''
+    application.logger.info('start server')
 
-    section = app['config'].get_section_name('web', architecture)
-    host = app['config'].get(section, 'host')
-    port = app['config'].getint(section, 'port')
+    section = application['config'].get_section_name('web', architecture)
+    host = application['config'].get(section, 'host')
+    port = application['config'].getint(section, 'port')
 
-    web.run_app(app, host=host, port=port, handle_signals=False)
+    web.run_app(application, host=host, port=port, handle_signals=False,
+                access_log=logging.getLogger('http'))
 
 
 def setup_service(architecture: str, config: Configuration) -> web.Application:
-    app = web.Application(logger=logging.getLogger('http'))
-    app.on_shutdown.append(on_shutdown)
-    app.on_startup.append(on_startup)
+    '''
+    create web application
+    :param architecture: repository architecture
+    :param config: configuration instance
+    :return: web application instance
+    '''
+    application = web.Application(logger=logging.getLogger('http'))
+    application.on_shutdown.append(on_shutdown)
+    application.on_startup.append(on_startup)
 
-    app.middlewares.append(web.normalize_path_middleware(append_slash=False, remove_slash=True))
-    app.middlewares.append(exception_handler(app.logger))
+    application.middlewares.append(web.normalize_path_middleware(append_slash=False, remove_slash=True))
+    application.middlewares.append(exception_handler(application.logger))
 
-    app.logger.info('setup routes')
-    setup_routes(app)
-    app.logger.info('setup templates')
-    aiohttp_jinja2.setup(app, loader=jinja2.FileSystemLoader(config.get('web', 'templates')))
+    application.logger.info('setup routes')
+    setup_routes(application)
+    application.logger.info('setup templates')
+    aiohttp_jinja2.setup(application, loader=jinja2.FileSystemLoader(config.get('web', 'templates')))
 
-    app.logger.info('setup configuration')
-    app['config'] = config
+    application.logger.info('setup configuration')
+    application['config'] = config
 
-    app.logger.info('setup watcher')
-    app['watcher'] = Watcher(architecture, config)
+    application.logger.info('setup watcher')
+    application['watcher'] = Watcher(architecture, config)
 
-    return app
+    return application