review fixes

Also change behaviour of the `from_option` method to fallback to
disabled instead of raising exception on unknown option

.gitignore

@@ -97,5 +97,3 @@ ENV/
 status_cache.json
 
 *.db
-
-docs/html/

.readthedocs.yaml

@@ -1,20 +0,0 @@
-version: 2
-
-formats: all
-
-build:
-  os: ubuntu-20.04
-  tools:
-    python: "3.9"
-
-sphinx:
-  builder: html
-  configuration: docs/conf.py
-
-python:
-  install:
-    - method: pip
-      path: .
-      extra_requirements:
-        - docs
-  system_packages: true

Makefile

@@ -1,4 +1,4 @@
-.PHONY: archive archive_directory archlinux check clean directory push spec spec-html tests version
+.PHONY: architecture archive archive_directory archlinux check clean directory man push tests version
 .DEFAULT_GOAL := archlinux
 
 PROJECT := ahriman
@@ -10,6 +10,9 @@ IGNORE_FILES := package/archlinux src/.mypy_cache
 $(TARGET_FILES) : $(addprefix $(PROJECT), %) : $(addprefix ., %) directory version
 	@cp -rp $< $@
 
+architecture:
+	cd src && pydeps ahriman -o ../docs/ahriman-architecture.svg --no-show --cluster
+
 archive: archive_directory
 	tar cJf "$(PROJECT)-$(VERSION)-src.tar.xz" "$(PROJECT)"
 	rm -rf "$(PROJECT)"
@@ -33,22 +36,16 @@ clean:
 directory: clean
 	mkdir "$(PROJECT)"
 
-push: spec archlinux
+man:
+	cd src &&  PYTHONPATH=. argparse-manpage --module ahriman.application.ahriman --function _parser --author "ahriman team" --project-name ahriman --author-email "" --url https://github.com/arcan1s/ahriman --output ../docs/ahriman.1
+
+push: architecture man archlinux
 	git add package/archlinux/PKGBUILD src/ahriman/version.py docs/ahriman-architecture.svg docs/ahriman.1
 	git commit -m "Release $(VERSION)"
 	git tag "$(VERSION)"
 	git push
 	git push --tags
 
-spec:
-	# make sure that old files are removed
-	find docs -type f -name "$(PROJECT)*.rst" -delete
-	tox -e docs
-
-spec-html: spec
-	rm -rf docs/html
-	tox -e docs-html
-
 tests: clean
 	tox -e tests
 

README.md

@@ -1,10 +1,9 @@
-# ArcH linux ReposItory MANager
+# ArcH Linux ReposItory MANager
 
 [![tests status](https://github.com/arcan1s/ahriman/actions/workflows/run-tests.yml/badge.svg)](https://github.com/arcan1s/ahriman/actions/workflows/run-tests.yml)
 [![setup status](https://github.com/arcan1s/ahriman/actions/workflows/run-setup.yml/badge.svg)](https://github.com/arcan1s/ahriman/actions/workflows/run-setup.yml)
 [![docker image](https://github.com/arcan1s/ahriman/actions/workflows/docker-image.yml/badge.svg)](https://github.com/arcan1s/ahriman/actions/workflows/docker-image.yml)
 [![CodeFactor](https://www.codefactor.io/repository/github/arcan1s/ahriman/badge)](https://www.codefactor.io/repository/github/arcan1s/ahriman)
-[![Documentation Status](https://readthedocs.org/projects/ahriman/badge/?version=latest)](https://ahriman.readthedocs.io/?badge=latest)
 
 Wrapper for managing custom repository inspired by [repo-scripts](https://github.com/arcan1s/repo-scripts).
 
@@ -23,10 +22,10 @@ Wrapper for managing custom repository inspired by [repo-scripts](https://github
 
 ## Installation and run
 
-For installation details please refer to the [documentation](docs/setup.rst). For command help, `--help` subcommand must be used. Subcommands have own help message as well. The package also provides a [man page](docs/ahriman.1).
+For installation details please refer to the [documentation](docs/setup.md). For command help, `--help` subcommand must be used. Subcommands have own help message as well. The package also provides a [man page](docs/ahriman.1).
 
 ## Configuration
 
-Every available option is described in the [documentation](docs/configuration.rst).
+Every available option is described in the [documentation](docs/configuration.md).
 
-## [FAQ](docs/faq.rst)
+## [FAQ](docs/faq.md)

docs/advanced-usage.rst

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

docs/ahriman.1

@@ -1,4 +1,4 @@
-.TH AHRIMAN "1" Manual
+.TH ahriman "1" Manual
 .SH NAME
 ahriman
 .SH SYNOPSIS
@@ -6,8 +6,8 @@ ahriman
 [-h] [-a ARCHITECTURE] [-c CONFIGURATION] [--force] [-l LOCK] [--no-report] [-q] [--unsafe] [-v] {aur-search,search,help,help-commands-unsafe,key-import,package-add,add,package-update,package-remove,remove,package-status,status,package-status-remove,package-status-update,status-update,patch-add,patch-list,patch-remove,repo-backup,repo-check,check,repo-clean,clean,repo-config,config,repo-rebuild,rebuild,repo-remove-unknown,remove-unknown,repo-report,report,repo-restore,repo-setup,init,repo-init,setup,repo-sign,sign,repo-status-update,repo-sync,sync,repo-update,update,user-add,user-list,user-remove,web} ...
 .SH DESCRIPTION
 ArcH Linux ReposItory MANager
-
 .SH OPTIONS
+
 .TP
 \fB\-a\fR \fI\,ARCHITECTURE\/\fR, \fB\-\-architecture\fR \fI\,ARCHITECTURE\/\fR
 target architectures (can be used multiple times)
@@ -40,8 +40,8 @@ allow to run ahriman as non\-ahriman user. Some actions might be unavailable
 \fB\-v\fR, \fB\-\-version\fR
 show program's version number and exit
 
-.SH
-COMMAND
+.SS
+\fBSub-commands\fR
 .TP
 \fBahriman\fR \fI\,aur-search\/\fR
 search for package
@@ -129,9 +129,9 @@ remove user
 .TP
 \fBahriman\fR \fI\,web\/\fR
 web server
-.SH COMMAND \fI\,'ahriman aur-search'\/\fR
+.SH OPTIONS 'ahriman aur-search'
 usage: ahriman aur-search [-h] [-e] [-i]
-                          [--sort-by {description,first_submitted,id,last_modified,maintainer,name,num_votes,out_of_date,package_base,package_base_id,popularity,repository,url,url_path,version}]
+                          [--sort-by {description,first_submitted,id,last_modified,maintainer,name,num_votes,out_of_date,package_base,package_base_id,popularity,url,url_path,version}]
                           search [search ...]
 
 search for package in AUR using API
@@ -140,7 +140,6 @@ search for package in AUR using API
 \fBsearch\fR
 search terms, can be specified multiple times, result will match all terms
 
-.SH OPTIONS \fI\,'ahriman aur-search'\/\fR
 .TP
 \fB\-e\fR, \fB\-\-exit\-code\fR
 return non\-zero exit status if result is empty
@@ -150,11 +149,35 @@ return non\-zero exit status if result is empty
 show additional package information
 
 .TP
-\fB\-\-sort\-by\fR \fI\,{description,first_submitted,id,last_modified,maintainer,name,num_votes,out_of_date,package_base,package_base_id,popularity,repository,url,url_path,version}\/\fR
+\fB\-\-sort\-by\fR {description,first_submitted,id,last_modified,maintainer,name,num_votes,out_of_date,package_base,package_base_id,popularity,url,url_path,version}
 sort field by this field. In case if two packages have the same value of the specified field, they will be always sorted
 by name
 
-.SH COMMAND \fI\,'ahriman help'\/\fR
+.SH OPTIONS 'ahriman search'
+usage: ahriman aur-search [-h] [-e] [-i]
+                          [--sort-by {description,first_submitted,id,last_modified,maintainer,name,num_votes,out_of_date,package_base,package_base_id,popularity,url,url_path,version}]
+                          search [search ...]
+
+search for package in AUR using API
+
+.TP
+\fBsearch\fR
+search terms, can be specified multiple times, result will match all terms
+
+.TP
+\fB\-e\fR, \fB\-\-exit\-code\fR
+return non\-zero exit status if result is empty
+
+.TP
+\fB\-i\fR, \fB\-\-info\fR
+show additional package information
+
+.TP
+\fB\-\-sort\-by\fR {description,first_submitted,id,last_modified,maintainer,name,num_votes,out_of_date,package_base,package_base_id,popularity,url,url_path,version}
+sort field by this field. In case if two packages have the same value of the specified field, they will be always sorted
+by name
+
+.SH OPTIONS 'ahriman help'
 usage: ahriman help [-h] [command]
 
 show help message for application or command and exit
@@ -163,18 +186,19 @@ show help message for application or command and exit
 \fBcommand\fR
 show help message for specific command
 
-.SH COMMAND \fI\,'ahriman help-commands-unsafe'\/\fR
+
+.SH OPTIONS 'ahriman help-commands-unsafe'
 usage: ahriman help-commands-unsafe [-h] [--command COMMAND]
 
 list unsafe commands as defined in default args
 
-.SH OPTIONS \fI\,'ahriman help-commands-unsafe'\/\fR
+
 .TP
 \fB\-\-command\fR \fI\,COMMAND\/\fR
 instead of showing commands, just test command line for unsafe subcommand and return 0 in case if command is safe and 1
 otherwise
 
-.SH COMMAND \fI\,'ahriman key-import'\/\fR
+.SH OPTIONS 'ahriman key-import'
 usage: ahriman key-import [-h] [--key-server KEY_SERVER] key
 
 import PGP key from public sources to the repository user
@@ -183,12 +207,11 @@ import PGP key from public sources to the repository user
 \fBkey\fR
 PGP key to import from public server
 
-.SH OPTIONS \fI\,'ahriman key-import'\/\fR
 .TP
 \fB\-\-key\-server\fR \fI\,KEY_SERVER\/\fR
 key server for key import
 
-.SH COMMAND \fI\,'ahriman package-add'\/\fR
+.SH OPTIONS 'ahriman package-add'
 usage: ahriman package-add [-h] [-e] [-n]
                            [-s {PackageSource.Auto,PackageSource.Archive,PackageSource.AUR,PackageSource.Directory,PackageSource.Local,PackageSource.Remote,PackageSource.Repository}]
                            [--without-dependencies]
@@ -200,7 +223,6 @@ add existing or new package to the build queue
 \fBpackage\fR
 package source (base name, path to local files, remote URL)
 
-.SH OPTIONS \fI\,'ahriman package-add'\/\fR
 .TP
 \fB\-e\fR, \fB\-\-exit\-code\fR
 return non\-zero exit status if result is empty
@@ -210,14 +232,70 @@ return non\-zero exit status if result is empty
 run update function after
 
 .TP
-\fB\-s\fR \fI\,{PackageSource.Auto,PackageSource.Archive,PackageSource.AUR,PackageSource.Directory,PackageSource.Local,PackageSource.Remote,PackageSource.Repository}\/\fR, \fB\-\-source\fR \fI\,{PackageSource.Auto,PackageSource.Archive,PackageSource.AUR,PackageSource.Directory,PackageSource.Local,PackageSource.Remote,PackageSource.Repository}\/\fR
+\fB\-s\fR {PackageSource.Auto,PackageSource.Archive,PackageSource.AUR,PackageSource.Directory,PackageSource.Local,PackageSource.Remote,PackageSource.Repository}, \fB\-\-source\fR {PackageSource.Auto,PackageSource.Archive,PackageSource.AUR,PackageSource.Directory,PackageSource.Local,PackageSource.Remote,PackageSource.Repository}
 explicitly specify the package source for this command
 
 .TP
 \fB\-\-without\-dependencies\fR
 do not add dependencies
 
-.SH COMMAND \fI\,'ahriman package-remove'\/\fR
+.SH OPTIONS 'ahriman add'
+usage: ahriman package-add [-h] [-e] [-n]
+                           [-s {PackageSource.Auto,PackageSource.Archive,PackageSource.AUR,PackageSource.Directory,PackageSource.Local,PackageSource.Remote,PackageSource.Repository}]
+                           [--without-dependencies]
+                           package [package ...]
+
+add existing or new package to the build queue
+
+.TP
+\fBpackage\fR
+package source (base name, path to local files, remote URL)
+
+.TP
+\fB\-e\fR, \fB\-\-exit\-code\fR
+return non\-zero exit status if result is empty
+
+.TP
+\fB\-n\fR, \fB\-\-now\fR
+run update function after
+
+.TP
+\fB\-s\fR {PackageSource.Auto,PackageSource.Archive,PackageSource.AUR,PackageSource.Directory,PackageSource.Local,PackageSource.Remote,PackageSource.Repository}, \fB\-\-source\fR {PackageSource.Auto,PackageSource.Archive,PackageSource.AUR,PackageSource.Directory,PackageSource.Local,PackageSource.Remote,PackageSource.Repository}
+explicitly specify the package source for this command
+
+.TP
+\fB\-\-without\-dependencies\fR
+do not add dependencies
+
+.SH OPTIONS 'ahriman package-update'
+usage: ahriman package-add [-h] [-e] [-n]
+                           [-s {PackageSource.Auto,PackageSource.Archive,PackageSource.AUR,PackageSource.Directory,PackageSource.Local,PackageSource.Remote,PackageSource.Repository}]
+                           [--without-dependencies]
+                           package [package ...]
+
+add existing or new package to the build queue
+
+.TP
+\fBpackage\fR
+package source (base name, path to local files, remote URL)
+
+.TP
+\fB\-e\fR, \fB\-\-exit\-code\fR
+return non\-zero exit status if result is empty
+
+.TP
+\fB\-n\fR, \fB\-\-now\fR
+run update function after
+
+.TP
+\fB\-s\fR {PackageSource.Auto,PackageSource.Archive,PackageSource.AUR,PackageSource.Directory,PackageSource.Local,PackageSource.Remote,PackageSource.Repository}, \fB\-\-source\fR {PackageSource.Auto,PackageSource.Archive,PackageSource.AUR,PackageSource.Directory,PackageSource.Local,PackageSource.Remote,PackageSource.Repository}
+explicitly specify the package source for this command
+
+.TP
+\fB\-\-without\-dependencies\fR
+do not add dependencies
+
+.SH OPTIONS 'ahriman package-remove'
 usage: ahriman package-remove [-h] package [package ...]
 
 remove package from the repository
@@ -226,7 +304,18 @@ remove package from the repository
 \fBpackage\fR
 package name or base
 
-.SH COMMAND \fI\,'ahriman package-status'\/\fR
+
+.SH OPTIONS 'ahriman remove'
+usage: ahriman package-remove [-h] package [package ...]
+
+remove package from the repository
+
+.TP
+\fBpackage\fR
+package name or base
+
+
+.SH OPTIONS 'ahriman package-status'
 usage: ahriman package-status [-h] [--ahriman] [-e] [-i]
                               [-s {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}]
                               [package ...]
@@ -237,7 +326,6 @@ request status of the package
 \fBpackage\fR
 filter status by package base
 
-.SH OPTIONS \fI\,'ahriman package-status'\/\fR
 .TP
 \fB\-\-ahriman\fR
 get service status itself
@@ -251,10 +339,37 @@ return non\-zero exit status if result is empty
 show additional package information
 
 .TP
-\fB\-s\fR \fI\,{BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}\/\fR, \fB\-\-status\fR \fI\,{BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}\/\fR
+\fB\-s\fR {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}, \fB\-\-status\fR {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}
 filter packages by status
 
-.SH COMMAND \fI\,'ahriman package-status-remove'\/\fR
+.SH OPTIONS 'ahriman status'
+usage: ahriman package-status [-h] [--ahriman] [-e] [-i]
+                              [-s {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}]
+                              [package ...]
+
+request status of the package
+
+.TP
+\fBpackage\fR
+filter status by package base
+
+.TP
+\fB\-\-ahriman\fR
+get service status itself
+
+.TP
+\fB\-e\fR, \fB\-\-exit\-code\fR
+return non\-zero exit status if result is empty
+
+.TP
+\fB\-i\fR, \fB\-\-info\fR
+show additional package information
+
+.TP
+\fB\-s\fR {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}, \fB\-\-status\fR {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}
+filter packages by status
+
+.SH OPTIONS 'ahriman package-status-remove'
 usage: ahriman package-status-remove [-h] package [package ...]
 
 remove the package from the status page
@@ -263,7 +378,8 @@ remove the package from the status page
 \fBpackage\fR
 remove specified packages
 
-.SH COMMAND \fI\,'ahriman package-status-update'\/\fR
+
+.SH OPTIONS 'ahriman package-status-update'
 usage: ahriman package-status-update [-h]
                                      [-s {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}]
                                      [package ...]
@@ -274,12 +390,26 @@ update package status on the status page
 \fBpackage\fR
 set status for specified packages. If no packages supplied, service status will be updated
 
-.SH OPTIONS \fI\,'ahriman package-status-update'\/\fR
 .TP
-\fB\-s\fR \fI\,{BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}\/\fR, \fB\-\-status\fR \fI\,{BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}\/\fR
+\fB\-s\fR {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}, \fB\-\-status\fR {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}
 new status
 
-.SH COMMAND \fI\,'ahriman patch-add'\/\fR
+.SH OPTIONS 'ahriman status-update'
+usage: ahriman package-status-update [-h]
+                                     [-s {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}]
+                                     [package ...]
+
+update package status on the status page
+
+.TP
+\fBpackage\fR
+set status for specified packages. If no packages supplied, service status will be updated
+
+.TP
+\fB\-s\fR {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}, \fB\-\-status\fR {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}
+new status
+
+.SH OPTIONS 'ahriman patch-add'
 usage: ahriman patch-add [-h] [-t TRACK] package
 
 create or update source patches
@@ -288,12 +418,11 @@ create or update source patches
 \fBpackage\fR
 path to directory with changed files for patch addition/update
 
-.SH OPTIONS \fI\,'ahriman patch-add'\/\fR
 .TP
 \fB\-t\fR \fI\,TRACK\/\fR, \fB\-\-track\fR \fI\,TRACK\/\fR
 files which has to be tracked
 
-.SH COMMAND \fI\,'ahriman patch-list'\/\fR
+.SH OPTIONS 'ahriman patch-list'
 usage: ahriman patch-list [-h] [-e] [package]
 
 list available patches for the package
@@ -302,12 +431,11 @@ list available patches for the package
 \fBpackage\fR
 package base
 
-.SH OPTIONS \fI\,'ahriman patch-list'\/\fR
 .TP
 \fB\-e\fR, \fB\-\-exit\-code\fR
 return non\-zero exit status if result is empty
 
-.SH COMMAND \fI\,'ahriman patch-remove'\/\fR
+.SH OPTIONS 'ahriman patch-remove'
 usage: ahriman patch-remove [-h] package
 
 remove patches for the package
@@ -316,7 +444,8 @@ remove patches for the package
 \fBpackage\fR
 package base
 
-.SH COMMAND \fI\,'ahriman repo-backup'\/\fR
+
+.SH OPTIONS 'ahriman repo-backup'
 usage: ahriman repo-backup [-h] path
 
 backup settings and database
@@ -325,7 +454,8 @@ backup settings and database
 \fBpath\fR
 path of the output archive
 
-.SH COMMAND \fI\,'ahriman repo-check'\/\fR
+
+.SH OPTIONS 'ahriman repo-check'
 usage: ahriman repo-check [-h] [-e] [--no-vcs] [package ...]
 
 check for packages updates. Same as update \-\-dry\-run \-\-no\-manual
@@ -334,7 +464,6 @@ check for packages updates. Same as update \-\-dry\-run \-\-no\-manual
 \fBpackage\fR
 filter check by package base
 
-.SH OPTIONS \fI\,'ahriman repo-check'\/\fR
 .TP
 \fB\-e\fR, \fB\-\-exit\-code\fR
 return non\-zero exit status if result is empty
@@ -343,12 +472,29 @@ return non\-zero exit status if result is empty
 \fB\-\-no\-vcs\fR
 do not check VCS packages
 
-.SH COMMAND \fI\,'ahriman repo-clean'\/\fR
+.SH OPTIONS 'ahriman check'
+usage: ahriman repo-check [-h] [-e] [--no-vcs] [package ...]
+
+check for packages updates. Same as update \-\-dry\-run \-\-no\-manual
+
+.TP
+\fBpackage\fR
+filter check by package base
+
+.TP
+\fB\-e\fR, \fB\-\-exit\-code\fR
+return non\-zero exit status if result is empty
+
+.TP
+\fB\-\-no\-vcs\fR
+do not check VCS packages
+
+.SH OPTIONS 'ahriman repo-clean'
 usage: ahriman repo-clean [-h] [--cache] [--chroot] [--manual] [--packages]
 
 remove local caches
 
-.SH OPTIONS \fI\,'ahriman repo-clean'\/\fR
+
 .TP
 \fB\-\-cache\fR
 clear directory with package caches
@@ -365,17 +511,48 @@ clear manually added packages queue
 \fB\-\-packages\fR
 clear directory with built packages
 
-.SH COMMAND \fI\,'ahriman repo-config'\/\fR
+.SH OPTIONS 'ahriman clean'
+usage: ahriman repo-clean [-h] [--cache] [--chroot] [--manual] [--packages]
+
+remove local caches
+
+
+.TP
+\fB\-\-cache\fR
+clear directory with package caches
+
+.TP
+\fB\-\-chroot\fR
+clear build chroot
+
+.TP
+\fB\-\-manual\fR
+clear manually added packages queue
+
+.TP
+\fB\-\-packages\fR
+clear directory with built packages
+
+.SH OPTIONS 'ahriman repo-config'
 usage: ahriman repo-config [-h]
 
 dump configuration for the specified architecture
 
-.SH COMMAND \fI\,'ahriman repo-rebuild'\/\fR
+
+
+.SH OPTIONS 'ahriman config'
+usage: ahriman repo-config [-h]
+
+dump configuration for the specified architecture
+
+
+
+.SH OPTIONS 'ahriman repo-rebuild'
 usage: ahriman repo-rebuild [-h] [--depends-on DEPENDS_ON] [--dry-run] [--from-database] [-e]
 
 force rebuild whole repository
 
-.SH OPTIONS \fI\,'ahriman repo-rebuild'\/\fR
+
 .TP
 \fB\-\-depends\-on\fR \fI\,DEPENDS_ON\/\fR
 only rebuild packages that depend on specified package
@@ -394,12 +571,36 @@ original ahriman instance run with web service and have run repo\-update at leas
 \fB\-e\fR, \fB\-\-exit\-code\fR
 return non\-zero exit status if result is empty
 
-.SH COMMAND \fI\,'ahriman repo-remove-unknown'\/\fR
+.SH OPTIONS 'ahriman rebuild'
+usage: ahriman repo-rebuild [-h] [--depends-on DEPENDS_ON] [--dry-run] [--from-database] [-e]
+
+force rebuild whole repository
+
+
+.TP
+\fB\-\-depends\-on\fR \fI\,DEPENDS_ON\/\fR
+only rebuild packages that depend on specified package
+
+.TP
+\fB\-\-dry\-run\fR
+just perform check for packages without rebuild process itself
+
+.TP
+\fB\-\-from\-database\fR
+read packages from database instead of filesystem. This feature in particular is required in case if you would like to
+restore repository from another repository instance. Note however that in order to restore packages you need to have
+original ahriman instance run with web service and have run repo\-update at least once.
+
+.TP
+\fB\-e\fR, \fB\-\-exit\-code\fR
+return non\-zero exit status if result is empty
+
+.SH OPTIONS 'ahriman repo-remove-unknown'
 usage: ahriman repo-remove-unknown [-h] [--dry-run] [-i]
 
 remove packages which are missing in AUR and do not have local PKGBUILDs
 
-.SH OPTIONS \fI\,'ahriman repo-remove-unknown'\/\fR
+
 .TP
 \fB\-\-dry\-run\fR
 just perform check for packages without removal
@@ -408,7 +609,21 @@ just perform check for packages without removal
 \fB\-i\fR, \fB\-\-info\fR
 show additional package information
 
-.SH COMMAND \fI\,'ahriman repo-report'\/\fR
+.SH OPTIONS 'ahriman remove-unknown'
+usage: ahriman repo-remove-unknown [-h] [--dry-run] [-i]
+
+remove packages which are missing in AUR and do not have local PKGBUILDs
+
+
+.TP
+\fB\-\-dry\-run\fR
+just perform check for packages without removal
+
+.TP
+\fB\-i\fR, \fB\-\-info\fR
+show additional package information
+
+.SH OPTIONS 'ahriman repo-report'
 usage: ahriman repo-report [-h] [target ...]
 
 generate repository report according to current settings
@@ -417,7 +632,18 @@ generate repository report according to current settings
 \fBtarget\fR
 target to generate report
 
-.SH COMMAND \fI\,'ahriman repo-restore'\/\fR
+
+.SH OPTIONS 'ahriman report'
+usage: ahriman repo-report [-h] [target ...]
+
+generate repository report according to current settings
+
+.TP
+\fBtarget\fR
+target to generate report
+
+
+.SH OPTIONS 'ahriman repo-restore'
 usage: ahriman repo-restore [-h] [-o OUTPUT] path
 
 restore settings and database
@@ -426,21 +652,19 @@ restore settings and database
 \fBpath\fR
 path of the input archive
 
-.SH OPTIONS \fI\,'ahriman repo-restore'\/\fR
 .TP
 \fB\-o\fR \fI\,OUTPUT\/\fR, \fB\-\-output\fR \fI\,OUTPUT\/\fR
 root path of the extracted files
 
-.SH COMMAND \fI\,'ahriman repo-setup'\/\fR
+.SH OPTIONS 'ahriman repo-setup'
 usage: ahriman repo-setup [-h] [--build-as-user BUILD_AS_USER] [--build-command BUILD_COMMAND]
                           [--from-configuration FROM_CONFIGURATION] [--no-multilib] --packager PACKAGER --repository
                           REPOSITORY [--sign-key SIGN_KEY]
-                          [--sign-target {SignSettings.Disabled,SignSettings.Packages,SignSettings.Repository}]
-                          [--web-port WEB_PORT]
+                          [--sign-target {SignSettings.Packages,SignSettings.Repository}] [--web-port WEB_PORT]
 
 create initial service configuration, requires root
 
-.SH OPTIONS \fI\,'ahriman repo-setup'\/\fR
+
 .TP
 \fB\-\-build\-as\-user\fR \fI\,BUILD_AS_USER\/\fR
 force makepkg user to the specific one
@@ -470,14 +694,149 @@ repository name
 sign key id
 
 .TP
-\fB\-\-sign\-target\fR \fI\,{SignSettings.Disabled,SignSettings.Packages,SignSettings.Repository}\/\fR
+\fB\-\-sign\-target\fR {SignSettings.Packages,SignSettings.Repository}
 sign options
 
 .TP
 \fB\-\-web\-port\fR \fI\,WEB_PORT\/\fR
 port of the web service
 
-.SH COMMAND \fI\,'ahriman repo-sign'\/\fR
+.SH OPTIONS 'ahriman init'
+usage: ahriman repo-setup [-h] [--build-as-user BUILD_AS_USER] [--build-command BUILD_COMMAND]
+                          [--from-configuration FROM_CONFIGURATION] [--no-multilib] --packager PACKAGER --repository
+                          REPOSITORY [--sign-key SIGN_KEY]
+                          [--sign-target {SignSettings.Packages,SignSettings.Repository}] [--web-port WEB_PORT]
+
+create initial service configuration, requires root
+
+
+.TP
+\fB\-\-build\-as\-user\fR \fI\,BUILD_AS_USER\/\fR
+force makepkg user to the specific one
+
+.TP
+\fB\-\-build\-command\fR \fI\,BUILD_COMMAND\/\fR
+build command prefix
+
+.TP
+\fB\-\-from\-configuration\fR \fI\,FROM_CONFIGURATION\/\fR
+path to default devtools pacman configuration
+
+.TP
+\fB\-\-no\-multilib\fR
+do not add multilib repository
+
+.TP
+\fB\-\-packager\fR \fI\,PACKAGER\/\fR
+packager name and email
+
+.TP
+\fB\-\-repository\fR \fI\,REPOSITORY\/\fR
+repository name
+
+.TP
+\fB\-\-sign\-key\fR \fI\,SIGN_KEY\/\fR
+sign key id
+
+.TP
+\fB\-\-sign\-target\fR {SignSettings.Packages,SignSettings.Repository}
+sign options
+
+.TP
+\fB\-\-web\-port\fR \fI\,WEB_PORT\/\fR
+port of the web service
+
+.SH OPTIONS 'ahriman repo-init'
+usage: ahriman repo-setup [-h] [--build-as-user BUILD_AS_USER] [--build-command BUILD_COMMAND]
+                          [--from-configuration FROM_CONFIGURATION] [--no-multilib] --packager PACKAGER --repository
+                          REPOSITORY [--sign-key SIGN_KEY]
+                          [--sign-target {SignSettings.Packages,SignSettings.Repository}] [--web-port WEB_PORT]
+
+create initial service configuration, requires root
+
+
+.TP
+\fB\-\-build\-as\-user\fR \fI\,BUILD_AS_USER\/\fR
+force makepkg user to the specific one
+
+.TP
+\fB\-\-build\-command\fR \fI\,BUILD_COMMAND\/\fR
+build command prefix
+
+.TP
+\fB\-\-from\-configuration\fR \fI\,FROM_CONFIGURATION\/\fR
+path to default devtools pacman configuration
+
+.TP
+\fB\-\-no\-multilib\fR
+do not add multilib repository
+
+.TP
+\fB\-\-packager\fR \fI\,PACKAGER\/\fR
+packager name and email
+
+.TP
+\fB\-\-repository\fR \fI\,REPOSITORY\/\fR
+repository name
+
+.TP
+\fB\-\-sign\-key\fR \fI\,SIGN_KEY\/\fR
+sign key id
+
+.TP
+\fB\-\-sign\-target\fR {SignSettings.Packages,SignSettings.Repository}
+sign options
+
+.TP
+\fB\-\-web\-port\fR \fI\,WEB_PORT\/\fR
+port of the web service
+
+.SH OPTIONS 'ahriman setup'
+usage: ahriman repo-setup [-h] [--build-as-user BUILD_AS_USER] [--build-command BUILD_COMMAND]
+                          [--from-configuration FROM_CONFIGURATION] [--no-multilib] --packager PACKAGER --repository
+                          REPOSITORY [--sign-key SIGN_KEY]
+                          [--sign-target {SignSettings.Packages,SignSettings.Repository}] [--web-port WEB_PORT]
+
+create initial service configuration, requires root
+
+
+.TP
+\fB\-\-build\-as\-user\fR \fI\,BUILD_AS_USER\/\fR
+force makepkg user to the specific one
+
+.TP
+\fB\-\-build\-command\fR \fI\,BUILD_COMMAND\/\fR
+build command prefix
+
+.TP
+\fB\-\-from\-configuration\fR \fI\,FROM_CONFIGURATION\/\fR
+path to default devtools pacman configuration
+
+.TP
+\fB\-\-no\-multilib\fR
+do not add multilib repository
+
+.TP
+\fB\-\-packager\fR \fI\,PACKAGER\/\fR
+packager name and email
+
+.TP
+\fB\-\-repository\fR \fI\,REPOSITORY\/\fR
+repository name
+
+.TP
+\fB\-\-sign\-key\fR \fI\,SIGN_KEY\/\fR
+sign key id
+
+.TP
+\fB\-\-sign\-target\fR {SignSettings.Packages,SignSettings.Repository}
+sign options
+
+.TP
+\fB\-\-web\-port\fR \fI\,WEB_PORT\/\fR
+port of the web service
+
+.SH OPTIONS 'ahriman repo-sign'
 usage: ahriman repo-sign [-h] [package ...]
 
 (re\-)sign packages and repository database according to current settings
@@ -486,18 +845,29 @@ usage: ahriman repo-sign [-h] [package ...]
 \fBpackage\fR
 sign only specified packages
 
-.SH COMMAND \fI\,'ahriman repo-status-update'\/\fR
+
+.SH OPTIONS 'ahriman sign'
+usage: ahriman repo-sign [-h] [package ...]
+
+(re\-)sign packages and repository database according to current settings
+
+.TP
+\fBpackage\fR
+sign only specified packages
+
+
+.SH OPTIONS 'ahriman repo-status-update'
 usage: ahriman repo-status-update [-h]
                                   [-s {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}]
 
 update repository status on the status page
 
-.SH OPTIONS \fI\,'ahriman repo-status-update'\/\fR
+
 .TP
-\fB\-s\fR \fI\,{BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}\/\fR, \fB\-\-status\fR \fI\,{BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}\/\fR
+\fB\-s\fR {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}, \fB\-\-status\fR {BuildStatusEnum.Unknown,BuildStatusEnum.Pending,BuildStatusEnum.Building,BuildStatusEnum.Failed,BuildStatusEnum.Success}
 new status
 
-.SH COMMAND \fI\,'ahriman repo-sync'\/\fR
+.SH OPTIONS 'ahriman repo-sync'
 usage: ahriman repo-sync [-h] [target ...]
 
 sync repository files to remote server according to current settings
@@ -506,7 +876,18 @@ sync repository files to remote server according to current settings
 \fBtarget\fR
 target to sync
 
-.SH COMMAND \fI\,'ahriman repo-update'\/\fR
+
+.SH OPTIONS 'ahriman sync'
+usage: ahriman repo-sync [-h] [target ...]
+
+sync repository files to remote server according to current settings
+
+.TP
+\fBtarget\fR
+target to sync
+
+
+.SH OPTIONS 'ahriman repo-update'
 usage: ahriman repo-update [-h] [--dry-run] [-e] [--no-aur] [--no-local] [--no-manual] [--no-vcs] [package ...]
 
 check for packages updates and run build process if requested
@@ -515,7 +896,6 @@ check for packages updates and run build process if requested
 \fBpackage\fR
 filter check by package base
 
-.SH OPTIONS \fI\,'ahriman repo-update'\/\fR
 .TP
 \fB\-\-dry\-run\fR
 just perform check for updates, same as check command
@@ -540,7 +920,40 @@ do not include manual updates
 \fB\-\-no\-vcs\fR
 do not check VCS packages
 
-.SH COMMAND \fI\,'ahriman user-add'\/\fR
+.SH OPTIONS 'ahriman update'
+usage: ahriman repo-update [-h] [--dry-run] [-e] [--no-aur] [--no-local] [--no-manual] [--no-vcs] [package ...]
+
+check for packages updates and run build process if requested
+
+.TP
+\fBpackage\fR
+filter check by package base
+
+.TP
+\fB\-\-dry\-run\fR
+just perform check for updates, same as check command
+
+.TP
+\fB\-e\fR, \fB\-\-exit\-code\fR
+return non\-zero exit status if result is empty
+
+.TP
+\fB\-\-no\-aur\fR
+do not check for AUR updates. Implies \-\-no\-vcs
+
+.TP
+\fB\-\-no\-local\fR
+do not check local packages for updates
+
+.TP
+\fB\-\-no\-manual\fR
+do not include manual updates
+
+.TP
+\fB\-\-no\-vcs\fR
+do not check VCS packages
+
+.SH OPTIONS 'ahriman user-add'
 usage: ahriman user-add [-h] [--as-service] [-p PASSWORD] [-r {UserAccess.Safe,UserAccess.Read,UserAccess.Write}] [-s]
                         username
 
@@ -550,7 +963,6 @@ update user for web services with the given password and role. In case if passwo
 \fBusername\fR
 username for web service
 
-.SH OPTIONS \fI\,'ahriman user-add'\/\fR
 .TP
 \fB\-\-as\-service\fR
 add user as service user
@@ -561,14 +973,14 @@ user password. Blank password will be treated as empty password, which is in par
 authorization type.
 
 .TP
-\fB\-r\fR \fI\,{UserAccess.Safe,UserAccess.Read,UserAccess.Write}\/\fR, \fB\-\-role\fR \fI\,{UserAccess.Safe,UserAccess.Read,UserAccess.Write}\/\fR
+\fB\-r\fR {UserAccess.Safe,UserAccess.Read,UserAccess.Write}, \fB\-\-role\fR {UserAccess.Safe,UserAccess.Read,UserAccess.Write}
 user access level
 
 .TP
 \fB\-s\fR, \fB\-\-secure\fR
 set file permissions to user\-only
 
-.SH COMMAND \fI\,'ahriman user-list'\/\fR
+.SH OPTIONS 'ahriman user-list'
 usage: ahriman user-list [-h] [-e] [-r {UserAccess.Safe,UserAccess.Read,UserAccess.Write}] [username]
 
 list users from the user mapping and their roles
@@ -577,16 +989,15 @@ list users from the user mapping and their roles
 \fBusername\fR
 filter users by username
 
-.SH OPTIONS \fI\,'ahriman user-list'\/\fR
 .TP
 \fB\-e\fR, \fB\-\-exit\-code\fR
 return non\-zero exit status if result is empty
 
 .TP
-\fB\-r\fR \fI\,{UserAccess.Safe,UserAccess.Read,UserAccess.Write}\/\fR, \fB\-\-role\fR \fI\,{UserAccess.Safe,UserAccess.Read,UserAccess.Write}\/\fR
+\fB\-r\fR {UserAccess.Safe,UserAccess.Read,UserAccess.Write}, \fB\-\-role\fR {UserAccess.Safe,UserAccess.Read,UserAccess.Write}
 filter users by role
 
-.SH COMMAND \fI\,'ahriman user-remove'\/\fR
+.SH OPTIONS 'ahriman user-remove'
 usage: ahriman user-remove [-h] [-s] username
 
 remove user from the user mapping and update the configuration
@@ -595,26 +1006,23 @@ remove user from the user mapping and update the configuration
 \fBusername\fR
 username for web service
 
-.SH OPTIONS \fI\,'ahriman user-remove'\/\fR
 .TP
 \fB\-s\fR, \fB\-\-secure\fR
 set file permissions to user\-only
 
-.SH COMMAND \fI\,'ahriman web'\/\fR
+.SH OPTIONS 'ahriman web'
 usage: ahriman web [-h]
 
 start web server
 
+
+
 .SH COMMENTS
 Argument list can also be read from file by using @ prefix.
 
 .SH AUTHORS
-.nf
-ahriman team
-.fi.nf
-
-.fi
-
+.B ahriman
+was written by ahriman team <>.
 .SH DISTRIBUTION
 The latest version of ahriman may be downloaded from
 .UR https://github.com/arcan1s/ahriman

docs/ahriman.application.application.rst

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

docs/ahriman.application.handlers.rst

@@ -1,197 +0,0 @@
-ahriman.application.handlers package
-====================================
-
-Submodules
-----------
-
-ahriman.application.handlers.add module
----------------------------------------
-
-.. automodule:: ahriman.application.handlers.add
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.backup module
-------------------------------------------
-
-.. automodule:: ahriman.application.handlers.backup
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.clean module
------------------------------------------
-
-.. automodule:: ahriman.application.handlers.clean
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.dump module
-----------------------------------------
-
-.. automodule:: ahriman.application.handlers.dump
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.handler module
--------------------------------------------
-
-.. automodule:: ahriman.application.handlers.handler
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.help module
-----------------------------------------
-
-.. automodule:: ahriman.application.handlers.help
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.key\_import module
------------------------------------------------
-
-.. automodule:: ahriman.application.handlers.key_import
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.patch module
------------------------------------------
-
-.. automodule:: ahriman.application.handlers.patch
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.rebuild module
--------------------------------------------
-
-.. automodule:: ahriman.application.handlers.rebuild
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.remove module
-------------------------------------------
-
-.. automodule:: ahriman.application.handlers.remove
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.remove\_unknown module
----------------------------------------------------
-
-.. automodule:: ahriman.application.handlers.remove_unknown
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.report module
-------------------------------------------
-
-.. automodule:: ahriman.application.handlers.report
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.restore module
--------------------------------------------
-
-.. automodule:: ahriman.application.handlers.restore
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.search module
-------------------------------------------
-
-.. automodule:: ahriman.application.handlers.search
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.setup module
------------------------------------------
-
-.. automodule:: ahriman.application.handlers.setup
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.sign module
-----------------------------------------
-
-.. automodule:: ahriman.application.handlers.sign
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.status module
-------------------------------------------
-
-.. automodule:: ahriman.application.handlers.status
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.status\_update module
---------------------------------------------------
-
-.. automodule:: ahriman.application.handlers.status_update
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.sync module
-----------------------------------------
-
-.. automodule:: ahriman.application.handlers.sync
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.unsafe\_commands module
-----------------------------------------------------
-
-.. automodule:: ahriman.application.handlers.unsafe_commands
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.update module
-------------------------------------------
-
-.. automodule:: ahriman.application.handlers.update
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.users module
------------------------------------------
-
-.. automodule:: ahriman.application.handlers.users
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.application.handlers.web module
----------------------------------------
-
-.. automodule:: ahriman.application.handlers.web
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: ahriman.application.handlers
-   :members:
-   :no-undoc-members:
-   :show-inheritance:

docs/ahriman.application.rst

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

docs/ahriman.core.alpm.remote.rst

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

docs/ahriman.core.alpm.rst

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

docs/ahriman.core.auth.rst

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

docs/ahriman.core.build_tools.rst

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

docs/ahriman.core.database.data.rst

@@ -1,45 +0,0 @@
-ahriman.core.database.data package
-==================================
-
-Submodules
-----------
-
-ahriman.core.database.data.package\_remotes module
---------------------------------------------------
-
-.. automodule:: ahriman.core.database.data.package_remotes
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.core.database.data.package\_statuses module
----------------------------------------------------
-
-.. automodule:: ahriman.core.database.data.package_statuses
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.core.database.data.patches module
------------------------------------------
-
-.. automodule:: ahriman.core.database.data.patches
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.core.database.data.users module
----------------------------------------
-
-.. automodule:: ahriman.core.database.data.users
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: ahriman.core.database.data
-   :members:
-   :no-undoc-members:
-   :show-inheritance:

docs/ahriman.core.database.migrations.rst

@@ -1,29 +0,0 @@
-ahriman.core.database.migrations package
-========================================
-
-Submodules
-----------
-
-ahriman.core.database.migrations.m000\_initial module
------------------------------------------------------
-
-.. automodule:: ahriman.core.database.migrations.m000_initial
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.core.database.migrations.m001\_package\_source module
--------------------------------------------------------------
-
-.. automodule:: ahriman.core.database.migrations.m001_package_source
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: ahriman.core.database.migrations
-   :members:
-   :no-undoc-members:
-   :show-inheritance:

docs/ahriman.core.database.operations.rst

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

docs/ahriman.core.database.rst

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

docs/ahriman.core.formatters.rst

@@ -1,85 +0,0 @@
-ahriman.core.formatters package
-===============================
-
-Submodules
-----------
-
-ahriman.core.formatters.aur\_printer module
--------------------------------------------
-
-.. automodule:: ahriman.core.formatters.aur_printer
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.core.formatters.build\_printer module
----------------------------------------------
-
-.. automodule:: ahriman.core.formatters.build_printer
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.core.formatters.configuration\_printer module
------------------------------------------------------
-
-.. automodule:: ahriman.core.formatters.configuration_printer
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.core.formatters.package\_printer module
------------------------------------------------
-
-.. automodule:: ahriman.core.formatters.package_printer
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.core.formatters.printer module
---------------------------------------
-
-.. automodule:: ahriman.core.formatters.printer
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.core.formatters.status\_printer module
-----------------------------------------------
-
-.. automodule:: ahriman.core.formatters.status_printer
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.core.formatters.string\_printer module
-----------------------------------------------
-
-.. automodule:: ahriman.core.formatters.string_printer
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.core.formatters.update\_printer module
-----------------------------------------------
-
-.. automodule:: ahriman.core.formatters.update_printer
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.core.formatters.user\_printer module
---------------------------------------------
-
-.. automodule:: ahriman.core.formatters.user_printer
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: ahriman.core.formatters
-   :members:
-   :no-undoc-members:
-   :show-inheritance:

docs/ahriman.core.report.rst

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

docs/ahriman.core.repository.rst

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

docs/ahriman.core.rst

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

docs/ahriman.core.sign.rst

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

docs/ahriman.core.status.rst

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

docs/ahriman.core.upload.rst

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

docs/ahriman.models.rst

@@ -1,189 +0,0 @@
-ahriman.models package
-======================
-
-Submodules
-----------
-
-ahriman.models.action module
-----------------------------
-
-.. automodule:: ahriman.models.action
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.models.aur\_package module
-----------------------------------
-
-.. automodule:: ahriman.models.aur_package
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.models.auth\_settings module
-------------------------------------
-
-.. automodule:: ahriman.models.auth_settings
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.models.build\_status module
------------------------------------
-
-.. automodule:: ahriman.models.build_status
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.models.counters module
-------------------------------
-
-.. automodule:: ahriman.models.counters
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.models.internal\_status module
---------------------------------------
-
-.. automodule:: ahriman.models.internal_status
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.models.migration module
--------------------------------
-
-.. automodule:: ahriman.models.migration
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.models.migration\_result module
----------------------------------------
-
-.. automodule:: ahriman.models.migration_result
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.models.package module
------------------------------
-
-.. automodule:: ahriman.models.package
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.models.package\_description module
-------------------------------------------
-
-.. automodule:: ahriman.models.package_description
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.models.package\_source module
--------------------------------------
-
-.. automodule:: ahriman.models.package_source
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.models.property module
-------------------------------
-
-.. automodule:: ahriman.models.property
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.models.remote\_source module
-------------------------------------
-
-.. automodule:: ahriman.models.remote_source
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.models.report\_settings module
---------------------------------------
-
-.. automodule:: ahriman.models.report_settings
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.models.repository\_paths module
----------------------------------------
-
-.. automodule:: ahriman.models.repository_paths
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.models.result module
-----------------------------
-
-.. automodule:: ahriman.models.result
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.models.sign\_settings module
-------------------------------------
-
-.. automodule:: ahriman.models.sign_settings
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.models.smtp\_ssl\_settings module
------------------------------------------
-
-.. automodule:: ahriman.models.smtp_ssl_settings
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.models.upload\_settings module
---------------------------------------
-
-.. automodule:: ahriman.models.upload_settings
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.models.user module
---------------------------
-
-.. automodule:: ahriman.models.user
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.models.user\_access module
-----------------------------------
-
-.. automodule:: ahriman.models.user_access
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.models.user\_identity module
-------------------------------------
-
-.. automodule:: ahriman.models.user_identity
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: ahriman.models
-   :members:
-   :no-undoc-members:
-   :show-inheritance:

docs/ahriman.rst

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

docs/ahriman.web.middlewares.rst

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

docs/ahriman.web.rst

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

docs/ahriman.web.views.rst

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

docs/ahriman.web.views.service.rst

@@ -1,45 +0,0 @@
-ahriman.web.views.service package
-=================================
-
-Submodules
-----------
-
-ahriman.web.views.service.add module
-------------------------------------
-
-.. automodule:: ahriman.web.views.service.add
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.web.views.service.remove module
----------------------------------------
-
-.. automodule:: ahriman.web.views.service.remove
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.web.views.service.request module
-----------------------------------------
-
-.. automodule:: ahriman.web.views.service.request
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-ahriman.web.views.service.search module
----------------------------------------
-
-.. automodule:: ahriman.web.views.service.search
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: ahriman.web.views.service
-   :members:
-   :no-undoc-members:
-   :show-inheritance:

docs/ahriman.web.views.status.rst

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

docs/ahriman.web.views.user.rst

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

docs/architecture.md

@@ -0,0 +1,227 @@
+# Package structure
+
+Packages have strict rules of importing:
+
+* `ahriman.application` package must not be used anywhere except for itself.
+* `ahriman.core` and `ahriman.models` packages don't have any import restriction. Actually we would like to totally restrict importing of `core` package from `models`, but it is impossible at the moment.
+* `ahriman.web` package is allowed to be imported from `ahriman.application` (web handler only, only `ahriman.web.web` methods). It also must not be imported globally, only local import is allowed. 
+
+Full dependency diagram:
+
+![architecture](ahriman-architecture.svg)
+
+## `ahriman.application` package
+
+This package contains application (aka executable) related classes and everything for that. It also contains package called `ahriman.application.handlers` in which all available subcommands are described as separated classes derived from base `ahriman.application.handlers.handler.Handler` class.
+
+`ahriman.application.application.application.Application` (god class) is used for any interaction from parsers with repository, web etc. It is divided into multiple traits by functions (package related and repository related) in the same package.
+
+`ahriman.application.ahriman` contains only command line parses and executes specified `Handler` on success, `ahriman.application.lock.Lock` is additional class which provides file-based lock and also performs some common checks.
+
+## `ahriman.core` package
+
+This package contains everything which is required for any time of application run and separated to several packages:
+
+* `ahriman.core.alpm` package controls pacman related functions. It provides wrappers for `pyalpm` library and safe calls for repository tools (`repo-add` and `repo-remove`).
+* `ahriman.core.auth` package provides classes for authorization methods used by web mostly. Base class is `ahriman.core.auth.auth.Auth` which must be called by `load` method.
+* `ahriman.core.build_tools` is a package which provides wrapper for `devtools` commands.
+* `ahriman.core.database` is everything including data and schema migrations for database.
+* `ahriman.core.formatters` package provides `Printer` sub-classes for printing data (e.g. package properties) to stdout which are used by some handlers.
+* `ahriman.core.report` is a package with reporting classes. Usually it must be called by `ahriman.core.report.report.Report.load` method.
+* `ahriman.core.repository` contains several traits and base repository (`ahriman.core.repository.repository.Repository` class) implementation.
+* `ahriman.core.sign` package provides sign feature (only gpg calls are available).
+* `ahriman.core.status` contains helpers and watcher class which are required for web application. Reporter must be initialized by using `ahriman.core.status.client.Client.load` method.
+* `ahriman.core.upload` package provides sync feature, must be called by `ahriman.core.upload.upload.Upload.load` method.
+
+This package also provides some generic functions and classes which may be used by other packages:
+
+* `ahriman.core.configuration.Configuration` is an extension for standard `configparser` library.
+* `ahriman.core.exceptions` provides custom exceptions.
+* `ahriman.core.spawn.Spawn` is a tool which can spawn another `ahriman` process. This feature is used by web application.
+* `ahriman.core.tree` is a dependency tree implementation.
+
+## `ahriman.models` package
+
+It provides models for any other part of application. Unlike `ahriman.core` package classes from here provides only conversion methods (e.g. create class from another or convert to). Mostly case classes and enumerations.
+
+## `ahriman.web` package
+
+Web application. It is important that this package is isolated from any other to allow it to be optional feature (i.e. dependencies which are required by the package are optional).
+
+* `ahriman.web.middlewares` provides middlewares for request handlers.
+* `ahriman.web.views` contains web views derived from aiohttp view class.
+* `ahriman.web.routes` creates routes for web application.
+* `ahriman.web.web` provides main web application functions (e.g. start, initialization).
+
+# Application run
+
+* Parse command line arguments, find command and related handler which is set by parser.
+* Call `Handler.execute` method.
+* Define list of architectures to run. In case if there is more than one architecture specified run several subprocesses or process in current process otherwise. Class attribute `ALLOW_MULTI_ARCHITECTURE_RUN` controls whether application can be run in multiple processes or not - this feature is required for some handlers (e.g. `Web`) which should be able to spawn child process in daemon mode (it is impossible to do for daemonic processes).
+* In each child process call lock functions.
+* After success checks pass control to `Handler.run` method defined by specific handler class.
+* Return result (success or failure) of each subprocess and exit from application.
+* Some handlers may override their status and throw `ExitCode` exception. This exception is just silently suppressed and changes application exit code to `1`.
+
+In most cases handlers spawn god class `ahriman.application.application.Application` class and call required methods.
+
+Application is designed to run from `systemd` services and provides parametrized by architecture timer and service file for that.
+
+# Database
+
+The service uses SQLite database in order to store some internal info.
+
+## Database instance
+
+All methods related to specific part of database (basically operations per table) are split into different traits located inside `ahriman.core.database.operations` package. The base trait `ahriman.core.database.operations.operations.Operations` also provides generic methods for database access (e.g. row converters and transactional support).
+
+The `ahriman.core.database.sqlite.SQLite` class itself derives from all of these traits and implements methods for initialization, including migrations.
+
+## Schema and data migrations
+
+The schema migration are applied according to current `pragma user_info` values, located at `ahriman.core.database.migrations` package and named as `m000_migration_name.py` (the preceding `m` is required in order to import migration content for tests). Additional class `ahriman.core.database.migrations.Migrations` reads all migrations autmatically and applies them in alphabetical order.
+
+There are also data migrations which are located at `ahriman.core.database.data` package and move data from old-style (e.g. json files in filesystem, directory trees, etc) to the database. They are also part of migration and (unlike schema migrations) are applied only at specific version breakpoints (e.g. if `user_version` is more than 0 no initial migration will be applied).
+
+## Type conversions
+
+By default, it parses rows into python dictionary. In addition, the following pseudo-types are supported:
+
+* `Dict[str, Any]`, `List[Any]` - for storing JSON data structures in database (technically there is no restriction on types for dictionary keys and values, but it is recommended to use only string keys). The type is stored as `json` datatype and `json.loads` and `json.dumps` methods are used in order to read and write from/to database respectively.
+
+# Basic flows
+
+## Add new packages or rebuild existing
+
+Idea is to copy package to the directory from which it will be handled at the next update run. Different variants are supported:
+
+* If supplied argument is file then application moves the file to the directory with built packages. Same rule applies for directory, but in this case it copies every package-like file from the specified directory.
+* If supplied argument is directory and there is `PKGBUILD` file there it will be treated as local package. In this case it will queue this package to build and copy source files (`PKGBUILD` and `.SRCINFO`) to caches.
+* If supplied argument iis not file then application tries to lookup for the specified name in AUR and clones it into the directory with manual updates. This scenario can also handle package dependencies which are missing in repositories.
+
+This logic can be overwritten by specifying the `source` parameter, which is partially useful if you would like to add package from AUR, but there is local directory cloned from AUR.
+
+## Rebuild packages
+
+Same as add function for every package in repository. Optional filter by reverse dependency can be supplied.
+
+## Remove packages
+
+This flow removes package from filesystem, updates repository database and also runs synchronization and reporting methods.
+
+## Update packages
+
+This feature is divided into to stages: check AUR for updates and run rebuild for required packages. Whereas check does not do anything except for check itself, update flow is the following:
+
+1. Process every built package first. Those packages are usually added manually.
+2. Run sync and report methods.
+3. Generate dependency tree for packages to be built.
+4. For each level of tree it does:
+   1. Download package data from AUR.
+   2. Build every package in clean chroot.
+   3. Sign packages if required.
+   4. Add packages to database and sign database if required.
+   5. Process sync and report methods.
+
+After any step any package data is being removed.
+
+# Core functions reference
+
+## Configuration 
+
+`ahriman.core.configuration.Configuration` class provides some additional methods (e.g. `getpath` and `getlist`) and also combines multiple files into single configuration dictionary using architecture overrides. It is the recommended way to deal with settings.
+
+## Utils
+
+For every external command run (which is actually not recommended if possible) custom wrapper for `subprocess` is used. Additional functions `ahriman.core.auth.helpers` provide safe calls for `aiohttp_security` methods and are required to make this dependency optional.
+
+## Submodules
+
+Some packages provide different behaviour depending on configuration settings. In these cases inheritance is used and recommended way to deal with them is to call class method `load` from base classes.
+
+## Authorization
+
+The package provides several authorization methods: disabled, based on configuration and OAuth2. 
+
+Disabled (default) authorization provider just allows everything for everyone and does not have any specific configuration (it uses some default configuration parameters though). It also provides generic interface for derived classes.
+
+Mapping (aka configuration) provider uses hashed passwords with salt from the database in order to authenticate users. This provider also enables user permission checking (read/write) (authorization). Thus, it defines the following methods:
+
+* `check_credentials` - user password validation (authentication).
+* `verify_access` - user permission validation (authorization).
+
+Passwords must be stored in database as `hash(password + salt)`, where `password` is user defined password (taken from user input), `salt` is random string (any length) defined globally in configuration and `hash` is secure hash function. Thus, the following configuration
+
+```csv
+"username","password","access"
+"username","$6$rounds=656000$mWBiecMPrHAL1VgX$oU4Y5HH8HzlvMaxwkNEJjK13ozElyU1wAHBoO/WW5dAaE4YEfnB0X3FxbynKMl4FBdC3Ovap0jINz4LPkNADg0","read"
+```
+
+means that there is user `username` with `read` access and password `password` hashed by `sha512` with salt `salt`.
+
+OAuth provider uses library definitions (`aioauth-client`) in order _authenticate_ users. It still requires user permission to be set in database, thus it inherits mapping provider without any changes. Whereas we could override `check_credentials` (authentication method) by something custom, OAuth flow is a bit more complex than just forward request, thus we have to implement the flow in login form.
+
+OAuth's implementation also allows authenticating users via username + password (in the same way as mapping does) though it is not recommended for end-users and password must be left blank. In particular this feature is used by service reporting (aka robots).
+
+In order to configure users there are special commands.
+
+## Remote synchronization
+
+There are several supported synchronization providers, currently they are `rsync`, `s3`, `github`. 
+
+`rsync` provider does not have any specific logic except for running external rsync application with configured arguments. The service does not handle SSH configuration, thus it has to be configured before running application manually.
+
+`s3` provider uses `boto3` package and implements sync feature. The files are stored in architecture directory (e.g. if bucket is `repository`, packages will be stored in `repository/x86_64` for the `x86_64` architecture), bucket must be created before any action and API key must have permissions to write to the bucket. No external configuration required. In order to upload only changed files the service compares calculated hashes with the Amazon ETags, used realization is described [here](https://teppen.io/2018/10/23/aws_s3_verify_etags/). 
+
+`github` provider authenticates through basic auth, API key with repository write permissions is required. There will be created a release with the name of the architecture in case if it does not exist; files will be uploaded to the release assets. It also stores array of files and their MD5 checksums in release body in order to upload only changed ones. According to the Github API in case if there is already uploaded asset with the same name (e.g. database files), asset will be removed first.
+
+## Additional features
+
+Some features require optional dependencies to be installed:
+
+* Version control executables (e.g. `git`, `svn`) for VCS packages.
+* `gnupg` application for package and repository sign feature.
+* `rsync` application for rsync based repository sync.
+* `boto3` python package for `S3` sync.
+* `Jinja2` python package for HTML report generation (it is also used by web application).
+
+# Web application
+
+Web application requires the following python packages to be installed:
+
+* Core part requires `aiohttp` (application itself), `aiohttp_jinja2` and `Jinja2` (HTML generation from templates).
+* In addition, `aiohttp_debugtoolbar` is required for debug panel. Please note that this option does not work together with authorization and basically must not be used in production.
+* In addition, authorization feature requires `aiohttp_security`, `aiohttp_session` and `cryptography`.
+* In addition to base authorization dependencies, OAuth2 also requires `aioauth-client` library.
+
+## Middlewares
+
+Service provides some custom middlewares, e.g. logging every exception (except for user ones) and user authorization.
+
+## Web views
+
+All web views are defined in separated package and derived from `ahriman.web.views.base.Base` class which provides typed interfaces for web application. 
+
+REST API supports both form and JSON data, but the last one is recommended. 
+
+Different APIs are separated into different packages:
+
+* `ahriman.web.views.service` provides views for application controls.
+* `ahriman.web.views.status` package provides REST API for application reporting.
+* `ahriman.web.views.user` package provides login and logout methods which can be called without authorization.
+
+## Templating
+
+Package provides base jinja templates which can be overridden by settings. Vanilla templates are actively using bootstrap library.
+
+## Requests and scopes
+
+Service provides optional authorization which can be turned on in settings. In order to control user access there are two levels of authorization - read-only (only GET-like requests) and write (anything) which are provided by each web view directly.
+
+If this feature is configured any request will be prohibited without authentication. In addition, configuration flag `auth.safe_build_status` can be used in order to allow seeing main page without authorization.
+
+For authenticated users it uses encrypted session cookies to store tokens; encryption key is generated each time at the start of the application. It also stores expiration time of the session inside.
+
+## External calls
+
+Web application provides external calls to control main service. It spawns child process with specific arguments and waits for its termination. This feature must be used either with authorization or in safe (i.e. when status page is not available world-wide) environment.

docs/architecture.rst

@@ -1,261 +0,0 @@
-Architecture
-============
-
-Package structure
------------------
-
-Packages have strict rules of importing:
-
-* ``ahriman.application`` package must not be used anywhere except for itself.
-* ``ahriman.core`` and ``ahriman.models`` packages don't have any import restriction. Actually we would like to totally restrict importing of ``core`` package from ``models``\ , but it is impossible at the moment.
-* ``ahriman.web`` package is allowed to be imported from ``ahriman.application`` (web handler only, only ``ahriman.web.web`` methods). It also must not be imported globally, only local import is allowed. 
-
-Full dependency diagram:
-
-.. image:: ahriman-architecture.svg
-   :target: _images/ahriman-architecture.svg
-   :alt: architecture
-
-``ahriman.application`` package
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-This package contains application (aka executable) related classes and everything for that. It also contains package called ``ahriman.application.handlers`` in which all available subcommands are described as separated classes derived from base ``ahriman.application.handlers.handler.Handler`` class.
-
-``ahriman.application.application.application.Application`` (god class) is used for any interaction from parsers with repository, web etc. It is divided into multiple traits by functions (package related and repository related) in the same package.
-
-``ahriman.application.ahriman`` contains only command line parses and executes specified ``Handler`` on success, ``ahriman.application.lock.Lock`` is additional class which provides file-based lock and also performs some common checks.
-
-``ahriman.core`` package
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-This package contains everything which is required for any time of application run and separated to several packages:
-
-* ``ahriman.core.alpm`` package controls pacman related functions. It provides wrappers for ``pyalpm`` library and safe calls for repository tools (\ ``repo-add`` and ``repo-remove``\ ). Also this package contains ``ahriman.core.alpm.remote`` package which provides wrapper for remote sources (e.g. AUR RPC and official repositories RPC).
-* ``ahriman.core.auth`` package provides classes for authorization methods used by web mostly. Base class is ``ahriman.core.auth.auth.Auth`` which must be called by ``load`` method.
-* ``ahriman.core.build_tools`` is a package which provides wrapper for ``devtools`` commands.
-* ``ahriman.core.database`` is everything including data and schema migrations for database.
-* ``ahriman.core.formatters`` package provides ``Printer`` sub-classes for printing data (e.g. package properties) to stdout which are used by some handlers.
-* ``ahriman.core.report`` is a package with reporting classes. Usually it must be called by ``ahriman.core.report.report.Report.load`` method.
-* ``ahriman.core.repository`` contains several traits and base repository (\ ``ahriman.core.repository.repository.Repository`` class) implementation.
-* ``ahriman.core.sign`` package provides sign feature (only gpg calls are available).
-* ``ahriman.core.status`` contains helpers and watcher class which are required for web application. Reporter must be initialized by using ``ahriman.core.status.client.Client.load`` method.
-* ``ahriman.core.upload`` package provides sync feature, must be called by ``ahriman.core.upload.upload.Upload.load`` method.
-
-This package also provides some generic functions and classes which may be used by other packages:
-
-* ``ahriman.core.configuration.Configuration`` is an extension for standard ``configparser`` library.
-* ``ahriman.core.exceptions`` provides custom exceptions.
-* ``ahriman.core.spawn.Spawn`` is a tool which can spawn another ``ahriman`` process. This feature is used by web application.
-* ``ahriman.core.tree`` is a dependency tree implementation.
-
-``ahriman.models`` package
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-It provides models for any other part of application. Unlike ``ahriman.core`` package classes from here provides only conversion methods (e.g. create class from another or convert to). Mostly case classes and enumerations.
-
-``ahriman.web`` package
-^^^^^^^^^^^^^^^^^^^^^^^
-
-Web application. It is important that this package is isolated from any other to allow it to be optional feature (i.e. dependencies which are required by the package are optional).
-
-* ``ahriman.web.middlewares`` provides middlewares for request handlers.
-* ``ahriman.web.views`` contains web views derived from aiohttp view class.
-* ``ahriman.web.routes`` creates routes for web application.
-* ``ahriman.web.web`` provides main web application functions (e.g. start, initialization).
-
-Application run
----------------
-
-* Parse command line arguments, find command and related handler which is set by parser.
-* Call ``Handler.execute`` method.
-* Define list of architectures to run. In case if there is more than one architecture specified run several subprocesses or process in current process otherwise. Class attribute ``ALLOW_MULTI_ARCHITECTURE_RUN`` controls whether application can be run in multiple processes or not - this feature is required for some handlers (e.g. ``Web``\ ) which should be able to spawn child process in daemon mode (it is impossible to do for daemonic processes).
-* In each child process call lock functions.
-* After success checks pass control to ``Handler.run`` method defined by specific handler class.
-* Return result (success or failure) of each subprocess and exit from application.
-* Some handlers may override their status and throw ``ExitCode`` exception. This exception is just silently suppressed and changes application exit code to ``1``.
-
-In most cases handlers spawn god class ``ahriman.application.application.Application`` class and call required methods.
-
-Application is designed to run from ``systemd`` services and provides parametrized by architecture timer and service file for that.
-
-Database
---------
-
-The service uses SQLite database in order to store some internal info.
-
-Database instance
-^^^^^^^^^^^^^^^^^
-
-All methods related to specific part of database (basically operations per table) are split into different traits located inside ``ahriman.core.database.operations`` package. The base trait ``ahriman.core.database.operations.operations.Operations`` also provides generic methods for database access (e.g. row converters and transactional support).
-
-The ``ahriman.core.database.sqlite.SQLite`` class itself derives from all of these traits and implements methods for initialization, including migrations.
-
-Schema and data migrations
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-The schema migration are applied according to current ``pragma user_info`` values, located at ``ahriman.core.database.migrations`` package and named as ``m000_migration_name.py`` (the preceding ``m`` is required in order to import migration content for tests). Additional class ``ahriman.core.database.migrations.Migrations`` reads all migrations autmatically and applies them in alphabetical order.
-
-There are also data migrations which are located at ``ahriman.core.database.data`` package and move data from old-style (e.g. json files in filesystem, directory trees, etc) to the database. They are also part of migration and (unlike schema migrations) are applied only at specific version breakpoints (e.g. if ``user_version`` is more than 0 no initial migration will be applied).
-
-Type conversions
-^^^^^^^^^^^^^^^^
-
-By default, it parses rows into python dictionary. In addition, the following pseudo-types are supported:
-
-* ``Dict[str, Any]``\ , ``List[Any]`` - for storing JSON data structures in database (technically there is no restriction on types for dictionary keys and values, but it is recommended to use only string keys). The type is stored as ``json`` datatype and ``json.loads`` and ``json.dumps`` methods are used in order to read and write from/to database respectively.
-
-Basic flows
------------
-
-Add new packages or rebuild existing
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Idea is to copy package to the directory from which it will be handled at the next update run. Different variants are supported:
-
-* If supplied argument is file then application moves the file to the directory with built packages. Same rule applies for directory, but in this case it copies every package-like file from the specified directory.
-* If supplied argument is directory and there is ``PKGBUILD`` file there it will be treated as local package. In this case it will queue this package to build and copy source files (\ ``PKGBUILD`` and ``.SRCINFO``\ ) to caches.
-* If supplied argument iis not file then application tries to lookup for the specified name in AUR and clones it into the directory with manual updates. This scenario can also handle package dependencies which are missing in repositories.
-
-This logic can be overwritten by specifying the ``source`` parameter, which is partially useful if you would like to add package from AUR, but there is local directory cloned from AUR.
-
-Rebuild packages
-^^^^^^^^^^^^^^^^
-
-Same as add function for every package in repository. Optional filter by reverse dependency can be supplied.
-
-Remove packages
-^^^^^^^^^^^^^^^
-
-This flow removes package from filesystem, updates repository database and also runs synchronization and reporting methods.
-
-Update packages
-^^^^^^^^^^^^^^^
-
-This feature is divided into to stages: check AUR for updates and run rebuild for required packages. Whereas check does not do anything except for check itself, update flow is the following:
-
-#. Process every built package first. Those packages are usually added manually.
-#. Run sync and report methods.
-#. Generate dependency tree for packages to be built.
-#. For each level of tree it does:
-
-   #. Download package data from AUR.
-   #. Build every package in clean chroot.
-   #. Sign packages if required.
-   #. Add packages to database and sign database if required.
-   #. Process sync and report methods.
-
-After any step any package data is being removed.
-
-Core functions reference
-------------------------
-
-Configuration
-^^^^^^^^^^^^^
-
-``ahriman.core.configuration.Configuration`` class provides some additional methods (e.g. ``getpath`` and ``getlist``\ ) and also combines multiple files into single configuration dictionary using architecture overrides. It is the recommended way to deal with settings.
-
-Utils
-^^^^^
-
-For every external command run (which is actually not recommended if possible) custom wrapper for ``subprocess`` is used. Additional functions ``ahriman.core.auth.helpers`` provide safe calls for ``aiohttp_security`` methods and are required to make this dependency optional.
-
-Submodules
-^^^^^^^^^^
-
-Some packages provide different behaviour depending on configuration settings. In these cases inheritance is used and recommended way to deal with them is to call class method ``load`` from base classes.
-
-Authorization
-^^^^^^^^^^^^^
-
-The package provides several authorization methods: disabled, based on configuration and OAuth2. 
-
-Disabled (default) authorization provider just allows everything for everyone and does not have any specific configuration (it uses some default configuration parameters though). It also provides generic interface for derived classes.
-
-Mapping (aka configuration) provider uses hashed passwords with salt from the database in order to authenticate users. This provider also enables user permission checking (read/write) (authorization). Thus, it defines the following methods:
-
-* ``check_credentials`` - user password validation (authentication).
-* ``verify_access`` - user permission validation (authorization).
-
-Passwords must be stored in database as ``hash(password + salt)``\ , where ``password`` is user defined password (taken from user input), ``salt`` is random string (any length) defined globally in configuration and ``hash`` is secure hash function. Thus, the following configuration
-
-.. code-block::
-
-   "username","password","access"
-   "username","$6$rounds=656000$mWBiecMPrHAL1VgX$oU4Y5HH8HzlvMaxwkNEJjK13ozElyU1wAHBoO/WW5dAaE4YEfnB0X3FxbynKMl4FBdC3Ovap0jINz4LPkNADg0","read"
-
-means that there is user ``username`` with ``read`` access and password ``password`` hashed by ``sha512`` with salt ``salt``.
-
-OAuth provider uses library definitions (\ ``aioauth-client``\ ) in order *authenticate* users. It still requires user permission to be set in database, thus it inherits mapping provider without any changes. Whereas we could override ``check_credentials`` (authentication method) by something custom, OAuth flow is a bit more complex than just forward request, thus we have to implement the flow in login form.
-
-OAuth's implementation also allows authenticating users via username + password (in the same way as mapping does) though it is not recommended for end-users and password must be left blank. In particular this feature is used by service reporting (aka robots).
-
-In order to configure users there are special commands.
-
-Remote synchronization
-^^^^^^^^^^^^^^^^^^^^^^
-
-There are several supported synchronization providers, currently they are ``rsync``\ , ``s3``\ , ``github``. 
-
-``rsync`` provider does not have any specific logic except for running external rsync application with configured arguments. The service does not handle SSH configuration, thus it has to be configured before running application manually.
-
-``s3`` provider uses ``boto3`` package and implements sync feature. The files are stored in architecture directory (e.g. if bucket is ``repository``\ , packages will be stored in ``repository/x86_64`` for the ``x86_64`` architecture), bucket must be created before any action and API key must have permissions to write to the bucket. No external configuration required. In order to upload only changed files the service compares calculated hashes with the Amazon ETags, used realization is described `here <https://teppen.io/2018/10/23/aws_s3_verify_etags/>`_. 
-
-``github`` provider authenticates through basic auth, API key with repository write permissions is required. There will be created a release with the name of the architecture in case if it does not exist; files will be uploaded to the release assets. It also stores array of files and their MD5 checksums in release body in order to upload only changed ones. According to the Github API in case if there is already uploaded asset with the same name (e.g. database files), asset will be removed first.
-
-Additional features
-^^^^^^^^^^^^^^^^^^^
-
-Some features require optional dependencies to be installed:
-
-* Version control executables (e.g. ``git``\ , ``svn``\ ) for VCS packages.
-* ``gnupg`` application for package and repository sign feature.
-* ``rsync`` application for rsync based repository sync.
-* ``boto3`` python package for ``S3`` sync.
-* ``Jinja2`` python package for HTML report generation (it is also used by web application).
-
-Web application
----------------
-
-Web application requires the following python packages to be installed:
-
-* Core part requires ``aiohttp`` (application itself), ``aiohttp_jinja2`` and ``Jinja2`` (HTML generation from templates).
-* In addition, ``aiohttp_debugtoolbar`` is required for debug panel. Please note that this option does not work together with authorization and basically must not be used in production.
-* In addition, authorization feature requires ``aiohttp_security``\ , ``aiohttp_session`` and ``cryptography``.
-* In addition to base authorization dependencies, OAuth2 also requires ``aioauth-client`` library.
-
-Middlewares
-^^^^^^^^^^^
-
-Service provides some custom middlewares, e.g. logging every exception (except for user ones) and user authorization.
-
-Web views
-^^^^^^^^^
-
-All web views are defined in separated package and derived from ``ahriman.web.views.base.Base`` class which provides typed interfaces for web application. 
-
-REST API supports both form and JSON data, but the last one is recommended. 
-
-Different APIs are separated into different packages:
-
-* ``ahriman.web.views.service`` provides views for application controls.
-* ``ahriman.web.views.status`` package provides REST API for application reporting.
-* ``ahriman.web.views.user`` package provides login and logout methods which can be called without authorization.
-
-Templating
-^^^^^^^^^^
-
-Package provides base jinja templates which can be overridden by settings. Vanilla templates are actively using bootstrap library.
-
-Requests and scopes
-^^^^^^^^^^^^^^^^^^^
-
-Service provides optional authorization which can be turned on in settings. In order to control user access there are two levels of authorization - read-only (only GET-like requests) and write (anything) which are provided by each web view directly.
-
-If this feature is configured any request will be prohibited without authentication. In addition, configuration flag ``auth.safe_build_status`` can be used in order to allow seeing main page without authorization.
-
-For authenticated users it uses encrypted session cookies to store tokens; encryption key is generated each time at the start of the application. It also stores expiration time of the session inside.
-
-External calls
-^^^^^^^^^^^^^^
-
-Web application provides external calls to control main service. It spawns child process with specific arguments and waits for its termination. This feature must be used either with authorization or in safe (i.e. when status page is not available world-wide) environment.

docs/command-line.rst

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

docs/conf.py

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

docs/configuration.md

@@ -0,0 +1,188 @@
+# ahriman configuration
+
+Some groups can be specified for each architecture separately. E.g. if there are `build` and `build:x86_64` groups it will use the option from `build:x86_64` for the `x86_64` architecture and `build` for any other (architecture specific group has higher priority). In case if both groups are presented, architecture specific options will be merged into global ones overriding them.
+
+There are two variable types which have been added to default ones, they are paths and lists. List values will be read in the same way as shell does:
+
+* By default, it splits value by spaces excluding empty elements. 
+* In case if quotation mark (`"` or `'`) will be found, any spaces inside will be ignored.
+* In order to use quotation mark inside value it is required to put it to another quotation mark, e.g. `wor"'"d "with quote"` will be parsed as `["wor'd", "with quote"]` and vice versa.
+* Unclosed quotation mark is not allowed and will rise an exception.
+
+Path values, except for casting to `pathlib.Path` type, will be also expanded to absolute paths relative to the configuration path. E.g. if path is set to `ahriman.ini.d/logging.ini` and root configuration path is `/etc/ahriman.ini`, the value will be expanded to `/etc/ahriman.ini.d/logging.ini`. In order to disable path expand, use the full path, e.g. `/etc/ahriman.ini.d/logging.ini`. 
+
+## `settings` group
+
+Base configuration settings.
+
+* `include` - path to directory with configuration files overrides, string, required.
+* `database` - path to SQLite database, string, required.
+* `logging` - path to logging configuration, string, required. Check `logging.ini` for reference.
+
+## `alpm` group
+
+libalpm and AUR related configuration.
+
+* `aur_url` - base url for AUR, string, required.
+* `database` - path to pacman local database cache, string, required.
+* `repositories` - list of pacman repositories, space separated list of strings, required.
+* `root` - root for alpm library, string, required.
+
+## `auth` group
+
+Base authorization settings. `OAuth` provider requires `aioauth-client` library to be installed.
+
+* `target` - specifies authorization provider, string, optional, default `disabled`. Allowed values are `disabled`, `configuration`, `oauth`.
+* `client_id` - OAuth2 application client ID, string, required in case if `oauth` is used.
+* `client_secret` - OAuth2 application client secret key, string, required in case if `oauth` is used.
+* `max_age` - parameter which controls both cookie expiration and token expiration inside the service, integer, optional, default is 7 days.
+* `oauth_provider` - OAuth2 provider class name as is in `aioauth-client` (e.g. `GoogleClient`, `GithubClient` etc), string, required in case if `oauth` is used.
+* `oauth_scopes` - scopes list for OAuth2 provider, which will allow retrieving user email (which is used for checking user permissions), e.g. `https://www.googleapis.com/auth/userinfo.email` for `GoogleClient` or `user:email` for `GithubClient`, space separated list of strings, required in case if `oauth` is used.
+* `safe_build_status` - allow requesting status page without authorization, boolean, required.
+* `salt` - password hash salt, string, required in case if authorization enabled (automatically generated by `create-user` subcommand).
+
+Authorized users are stored inside internal database, if any of external provides are used the password field for non-service users must be empty. 
+
+## `build:*` groups
+
+Build related configuration. Group name can refer to architecture, e.g. `build:x86_64` can be used for x86_64 architecture specific settings.
+
+* `archbuild_flags` - additional flags passed to `archbuild` command, space separated list of strings, optional.
+* `build_command` - default build command, string, required.
+* `ignore_packages` - list packages to ignore during a regular update (manual update will still work), space separated list of strings, optional.
+* `makepkg_flags` - additional flags passed to `makepkg` command, space separated list of strings, optional.
+* `makechrootpkg_flags` - additional flags passed to `makechrootpkg` command, space separated list of strings, optional.
+
+## `repository` group
+
+Base repository settings.
+
+* `name` - repository name, string, required.
+* `root` - root path for application, string, required.
+
+## `sign:*` groups
+
+Settings for signing packages or repository. Group name can refer to architecture, e.g. `sign:x86_64` can be used for x86_64 architecture specific settings.
+
+* `target` - configuration flag to enable signing, space separated list of strings, required. Allowed values are `package` (sign each package separately), `repository` (sign repository database file).
+* `key` - default PGP key, string, required. This key will also be used for database signing if enabled.
+* `key_*` settings - PGP key which will be used for specific packages, string, optional. For example, if there is `key_yay` option the specified key will be used for yay package and default key for others.
+
+## `report` group
+
+Report generation settings.
+
+* `target` - list of reports to be generated, space separated list of strings, required. It must point to valid section (or to section with architecture), e.g. `somerandomname` must point to existing section, `email` must point to one of `email` of `email:x86_64` (the one with architecture has higher priority). 
+
+Type will be read from several ways:
+
+* In case if `type` option set inside the section, it will be used.
+* Otherwise, it will look for type from section name removing architecture name.
+* And finally, it will use section name as type.
+
+### `console` type
+
+Section name must be either `console` (plus optional architecture name, e.g. `console:x86_64`) or random name with `type` set.
+
+* `use_utf` - use utf8 symbols in output if set and ascii otherwise, boolean, optional, default `yes`.
+
+### `email` type
+
+Section name must be either `email` (plus optional architecture name, e.g. `email:x86_64`) or random name with `type` set.
+
+* `type` - type of the report, string, optional, must be set to `email` if exists.
+* `full_template_path` - path to Jinja2 template for full package description index, string, optional.
+* `homepage` - link to homepage, string, optional.
+* `host` - SMTP host for sending emails, string, required.
+* `link_path` - prefix for HTML links, string, required.
+* `no_empty_report` - skip report generation for empty packages list, boolean, optional, default `yes`.
+* `password` - SMTP password to authenticate, string, optional.
+* `port` - SMTP port for sending emails, int, required.
+* `receivers` - SMTP receiver addresses, space separated list of strings, required.
+* `sender` - SMTP sender address, string, required.
+* `ssl` - SSL mode for SMTP connection, one of `ssl`, `starttls`, `disabled`, optional, default `disabled`.
+* `template_path` - path to Jinja2 template, string, required.
+* `user` - SMTP user to authenticate, string, optional.
+
+### `html` type
+
+Section name must be either `html` (plus optional architecture name, e.g. `html:x86_64`) or random name with `type` set.
+
+* `type` - type of the report, string, optional, must be set to `html` if exists.
+* `path` - path to html report file, string, required.
+* `homepage` - link to homepage, string, optional.
+* `link_path` - prefix for HTML links, string, required.
+* `template_path` - path to Jinja2 template, string, required.
+
+### `telegram` type
+
+Section name must be either `telegram` (plus optional architecture name, e.g. `telegram:x86_64`) or random name with `type` set.
+
+* `type` - type of the report, string, optional, must be set to `telegram` if exists.
+* `api_key` - telegram bot API key, string, required. Please refer FAQ about how to create chat and bot
+* `chat_id` - telegram chat id, either string with `@` or integer value, required.
+* `homepage` - link to homepage, string, optional.
+* `link_path` - prefix for HTML links, string, required.
+* `template_path` - path to Jinja2 template, string, required.
+* `template_type` - `parse_mode` to be passed to telegram API, one of `MarkdownV2`, `HTML`, `Markdown`, string, optional, default `HTML`.
+
+## `upload` group
+
+Remote synchronization settings.
+
+* `target` - list of synchronizations to be used, space separated list of strings, required. It must point to valid section (or to section with architecture), e.g. `somerandomname` must point to existing section, `github` must point to one of `github` of `github:x86_64` (with architecture it has higher priority).
+
+Type will be read from several ways:
+
+* In case if `type` option set inside the section, it will be used.
+* Otherwise, it will look for type from section name removing architecture name.
+* And finally, it will use section name as type.
+
+### `github` type
+
+This feature requires Github key creation (see below). Section name must be either `github` (plus optional architecture name, e.g. `github:x86_64`) or random name with `type` set.
+
+* `type` - type of the upload, string, optional, must be set to `github` if exists.
+* `owner` - Github repository owner, string, required.
+* `password` - created Github API key. In order to create it do the following:
+  1. Go to [settings page](https://github.com/settings/profile).
+  2. Switch to [developers settings](https://github.com/settings/apps).
+  3. Switch to [personal access tokens](https://github.com/settings/tokens).
+  4. Generate new token. Required scope is `public_repo` (or `repo` for private repository support).
+* `repository` - Github repository name, string, required. Repository must be created before any action and must have active branch (e.g. with readme).
+* `username` - Github authorization user, string, required. Basically the same as `owner`.
+
+### `rsync` type
+
+Requires `rsync` package to be installed. Do not forget to configure ssh for user `ahriman`. Section name must be either `rsync` (plus optional architecture name, e.g. `rsync:x86_64`) or random name with `type` set.
+
+* `type` - type of the upload, string, optional, must be set to `rsync` if exists.
+* `command` - rsync command to run, space separated list of string, required.
+* `remote` - remote server to rsync (e.g. `1.2.3.4:path/to/sync`), string, required.
+
+### `s3` type
+
+Requires `boto3` library to be installed. Section name must be either `s3` (plus optional architecture name, e.g. `s3:x86_64`) or random name with `type` set.
+
+* `type` - type of the upload, string, optional, must be set to `github` if exists.
+* `access_key` - AWS access key ID, string, required.
+* `bucket` - bucket name (e.g. `bucket`), string, required.
+* `chunk_size` - chunk size for calculating entity tags, int, optional, default 8 * 1024 * 1024.
+* `region` - bucket region (e.g. `eu-central-1`), string, required.
+* `secret_key` - AWS secret access key, string, required.
+
+## `web:*` groups
+
+Web server settings. If any of `host`/`port` is not set, web integration will be disabled. Group name can refer to architecture, e.g. `web:x86_64` can be used for x86_64 architecture specific settings. This feature requires `aiohttp` libraries to be installed.
+
+* `address` - optional address in form `proto://host:port` (`port` can be omitted in case of default `proto` ports), will be used instead of `http://{host}:{port}` in case if set, string, optional. This option is required in case if `OAuth` provider is used.
+* `debug` - enable debug toolbar, boolean, optional, default `no`.
+* `debug_check_host` - check hosts to access debug toolbar, boolean, optional, default `no`.
+* `debug_allowed_hosts` - allowed hosts to get access to debug toolbar, space separated list of string, optional.
+* `host` - host to bind, string, optional.
+* `index_url` - full url of the repository index page, string, optional.
+* `password` - password to authorize in web service in order to update service status, string, required in case if authorization enabled.  
+* `port` - port to bind, int, optional.
+* `static_path` - path to directory with static files, string, required.
+* `templates` - path to templates directory, string, required.
+* `username` - username to authorize in web service in order to update service status, string, required in case if authorization enabled.  

docs/configuration.rst

@@ -1,206 +0,0 @@
-Configuration
-=============
-
-Some groups can be specified for each architecture separately. E.g. if there are ``build`` and ``build:x86_64`` groups it will use the option from ``build:x86_64`` for the ``x86_64`` architecture and ``build`` for any other (architecture specific group has higher priority). In case if both groups are presented, architecture specific options will be merged into global ones overriding them.
-
-There are two variable types which have been added to default ones, they are paths and lists. List values will be read in the same way as shell does:
-
-* By default, it splits value by spaces excluding empty elements. 
-* In case if quotation mark (\ ``"`` or ``'``\ ) will be found, any spaces inside will be ignored.
-* In order to use quotation mark inside value it is required to put it to another quotation mark, e.g. ``wor"'"d "with quote"`` will be parsed as ``["wor'd", "with quote"]`` and vice versa.
-* Unclosed quotation mark is not allowed and will rise an exception.
-
-Path values, except for casting to ``pathlib.Path`` type, will be also expanded to absolute paths relative to the configuration path. E.g. if path is set to ``ahriman.ini.d/logging.ini`` and root configuration path is ``/etc/ahriman.ini``\ , the value will be expanded to ``/etc/ahriman.ini.d/logging.ini``. In order to disable path expand, use the full path, e.g. ``/etc/ahriman.ini.d/logging.ini``. 
-
-``settings`` group
-------------------
-
-Base configuration settings.
-
-* ``include`` - path to directory with configuration files overrides, string, required.
-* ``database`` - path to SQLite database, string, required.
-* ``logging`` - path to logging configuration, string, required. Check ``logging.ini`` for reference.
-
-``alpm`` group
---------------
-
-libalpm and AUR related configuration.
-
-* ``database`` - path to pacman local database cache, string, required.
-* ``repositories`` - list of pacman repositories, space separated list of strings, required.
-* ``root`` - root for alpm library, string, required.
-
-``auth`` group
---------------
-
-Base authorization settings. ``OAuth`` provider requires ``aioauth-client`` library to be installed.
-
-* ``target`` - specifies authorization provider, string, optional, default ``disabled``. Allowed values are ``disabled``\ , ``configuration``\ , ``oauth``.
-* ``client_id`` - OAuth2 application client ID, string, required in case if ``oauth`` is used.
-* ``client_secret`` - OAuth2 application client secret key, string, required in case if ``oauth`` is used.
-* ``max_age`` - parameter which controls both cookie expiration and token expiration inside the service, integer, optional, default is 7 days.
-* ``oauth_provider`` - OAuth2 provider class name as is in ``aioauth-client`` (e.g. ``GoogleClient``\ , ``GithubClient`` etc), string, required in case if ``oauth`` is used.
-* ``oauth_scopes`` - scopes list for OAuth2 provider, which will allow retrieving user email (which is used for checking user permissions), e.g. ``https://www.googleapis.com/auth/userinfo.email`` for ``GoogleClient`` or ``user:email`` for ``GithubClient``\ , space separated list of strings, required in case if ``oauth`` is used.
-* ``safe_build_status`` - allow requesting status page without authorization, boolean, required.
-* ``salt`` - password hash salt, string, required in case if authorization enabled (automatically generated by ``create-user`` subcommand).
-
-Authorized users are stored inside internal database, if any of external provides are used the password field for non-service users must be empty. 
-
-``build:*`` groups
-------------------
-
-Build related configuration. Group name can refer to architecture, e.g. ``build:x86_64`` can be used for x86_64 architecture specific settings.
-
-* ``archbuild_flags`` - additional flags passed to ``archbuild`` command, space separated list of strings, optional.
-* ``build_command`` - default build command, string, required.
-* ``ignore_packages`` - list packages to ignore during a regular update (manual update will still work), space separated list of strings, optional.
-* ``makepkg_flags`` - additional flags passed to ``makepkg`` command, space separated list of strings, optional.
-* ``makechrootpkg_flags`` - additional flags passed to ``makechrootpkg`` command, space separated list of strings, optional.
-
-``repository`` group
---------------------
-
-Base repository settings.
-
-* ``name`` - repository name, string, required.
-* ``root`` - root path for application, string, required.
-
-``sign:*`` groups
------------------
-
-Settings for signing packages or repository. Group name can refer to architecture, e.g. ``sign:x86_64`` can be used for x86_64 architecture specific settings.
-
-* ``target`` - configuration flag to enable signing, space separated list of strings, required. Allowed values are ``package`` (sign each package separately), ``repository`` (sign repository database file).
-* ``key`` - default PGP key, string, required. This key will also be used for database signing if enabled.
-* ``key_*`` settings - PGP key which will be used for specific packages, string, optional. For example, if there is ``key_yay`` option the specified key will be used for yay package and default key for others.
-
-``report`` group
-----------------
-
-Report generation settings.
-
-* ``target`` - list of reports to be generated, space separated list of strings, required. It must point to valid section (or to section with architecture), e.g. ``somerandomname`` must point to existing section, ``email`` must point to one of ``email`` of ``email:x86_64`` (the one with architecture has higher priority). 
-
-Type will be read from several ways:
-
-* In case if ``type`` option set inside the section, it will be used.
-* Otherwise, it will look for type from section name removing architecture name.
-* And finally, it will use section name as type.
-
-``console`` type
-^^^^^^^^^^^^^^^^
-
-Section name must be either ``console`` (plus optional architecture name, e.g. ``console:x86_64``\ ) or random name with ``type`` set.
-
-* ``use_utf`` - use utf8 symbols in output if set and ascii otherwise, boolean, optional, default ``yes``.
-
-``email`` type
-^^^^^^^^^^^^^^
-
-Section name must be either ``email`` (plus optional architecture name, e.g. ``email:x86_64``\ ) or random name with ``type`` set.
-
-* ``type`` - type of the report, string, optional, must be set to ``email`` if exists.
-* ``full_template_path`` - path to Jinja2 template for full package description index, string, optional.
-* ``homepage`` - link to homepage, string, optional.
-* ``host`` - SMTP host for sending emails, string, required.
-* ``link_path`` - prefix for HTML links, string, required.
-* ``no_empty_report`` - skip report generation for empty packages list, boolean, optional, default ``yes``.
-* ``password`` - SMTP password to authenticate, string, optional.
-* ``port`` - SMTP port for sending emails, int, required.
-* ``receivers`` - SMTP receiver addresses, space separated list of strings, required.
-* ``sender`` - SMTP sender address, string, required.
-* ``ssl`` - SSL mode for SMTP connection, one of ``ssl``\ , ``starttls``\ , ``disabled``\ , optional, default ``disabled``.
-* ``template_path`` - path to Jinja2 template, string, required.
-* ``user`` - SMTP user to authenticate, string, optional.
-
-``html`` type
-^^^^^^^^^^^^^
-
-Section name must be either ``html`` (plus optional architecture name, e.g. ``html:x86_64``\ ) or random name with ``type`` set.
-
-* ``type`` - type of the report, string, optional, must be set to ``html`` if exists.
-* ``path`` - path to html report file, string, required.
-* ``homepage`` - link to homepage, string, optional.
-* ``link_path`` - prefix for HTML links, string, required.
-* ``template_path`` - path to Jinja2 template, string, required.
-
-``telegram`` type
-^^^^^^^^^^^^^^^^^
-
-Section name must be either ``telegram`` (plus optional architecture name, e.g. ``telegram:x86_64``\ ) or random name with ``type`` set.
-
-* ``type`` - type of the report, string, optional, must be set to ``telegram`` if exists.
-* ``api_key`` - telegram bot API key, string, required. Please refer FAQ about how to create chat and bot
-* ``chat_id`` - telegram chat id, either string with ``@`` or integer value, required.
-* ``homepage`` - link to homepage, string, optional.
-* ``link_path`` - prefix for HTML links, string, required.
-* ``template_path`` - path to Jinja2 template, string, required.
-* ``template_type`` - ``parse_mode`` to be passed to telegram API, one of ``MarkdownV2``\ , ``HTML``\ , ``Markdown``\ , string, optional, default ``HTML``.
-
-``upload`` group
-----------------
-
-Remote synchronization settings.
-
-* ``target`` - list of synchronizations to be used, space separated list of strings, required. It must point to valid section (or to section with architecture), e.g. ``somerandomname`` must point to existing section, ``github`` must point to one of ``github`` of ``github:x86_64`` (with architecture it has higher priority).
-
-Type will be read from several ways:
-
-* In case if ``type`` option set inside the section, it will be used.
-* Otherwise, it will look for type from section name removing architecture name.
-* And finally, it will use section name as type.
-
-``github`` type
-^^^^^^^^^^^^^^^
-
-This feature requires Github key creation (see below). Section name must be either ``github`` (plus optional architecture name, e.g. ``github:x86_64``\ ) or random name with ``type`` set.
-
-* ``type`` - type of the upload, string, optional, must be set to ``github`` if exists.
-* ``owner`` - Github repository owner, string, required.
-* ``password`` - created Github API key. In order to create it do the following:
-
-  #. Go to `settings page <https://github.com/settings/profile>`_.
-  #. Switch to `developers settings <https://github.com/settings/apps>`_.
-  #. Switch to `personal access tokens <https://github.com/settings/tokens>`_.
-  #. Generate new token. Required scope is ``public_repo`` (or ``repo`` for private repository support).
-
-* ``repository`` - Github repository name, string, required. Repository must be created before any action and must have active branch (e.g. with readme).
-* ``username`` - Github authorization user, string, required. Basically the same as ``owner``.
-
-``rsync`` type
-^^^^^^^^^^^^^^
-
-Requires ``rsync`` package to be installed. Do not forget to configure ssh for user ``ahriman``. Section name must be either ``rsync`` (plus optional architecture name, e.g. ``rsync:x86_64``\ ) or random name with ``type`` set.
-
-* ``type`` - type of the upload, string, optional, must be set to ``rsync`` if exists.
-* ``command`` - rsync command to run, space separated list of string, required.
-* ``remote`` - remote server to rsync (e.g. ``1.2.3.4:path/to/sync``\ ), string, required.
-
-``s3`` type
-^^^^^^^^^^^
-
-Requires ``boto3`` library to be installed. Section name must be either ``s3`` (plus optional architecture name, e.g. ``s3:x86_64``\ ) or random name with ``type`` set.
-
-* ``type`` - type of the upload, string, optional, must be set to ``github`` if exists.
-* ``access_key`` - AWS access key ID, string, required.
-* ``bucket`` - bucket name (e.g. ``bucket``\ ), string, required.
-* ``chunk_size`` - chunk size for calculating entity tags, int, optional, default 8 * 1024 * 1024.
-* ``region`` - bucket region (e.g. ``eu-central-1``\ ), string, required.
-* ``secret_key`` - AWS secret access key, string, required.
-
-``web:*`` groups
-----------------
-
-Web server settings. If any of ``host``\ /\ ``port`` is not set, web integration will be disabled. Group name can refer to architecture, e.g. ``web:x86_64`` can be used for x86_64 architecture specific settings. This feature requires ``aiohttp`` libraries to be installed.
-
-* ``address`` - optional address in form ``proto://host:port`` (\ ``port`` can be omitted in case of default ``proto`` ports), will be used instead of ``http://{host}:{port}`` in case if set, string, optional. This option is required in case if ``OAuth`` provider is used.
-* ``debug`` - enable debug toolbar, boolean, optional, default ``no``.
-* ``debug_check_host`` - check hosts to access debug toolbar, boolean, optional, default ``no``.
-* ``debug_allowed_hosts`` - allowed hosts to get access to debug toolbar, space separated list of string, optional.
-* ``host`` - host to bind, string, optional.
-* ``index_url`` - full url of the repository index page, string, optional.
-* ``password`` - password to authorize in web service in order to update service status, string, required in case if authorization enabled.  
-* ``port`` - port to bind, int, optional.
-* ``static_path`` - path to directory with static files, string, required.
-* ``templates`` - path to templates directory, string, required.
-* ``username`` - username to authorize in web service in order to update service status, string, required in case if authorization enabled.  

docs/faq.md

@@ -0,0 +1,613 @@
+# FAQ
+
+## General topics
+
+### What is the purpose of the project?
+
+This project has been created in order to maintain self-hosted Arch Linux user repository without manual intervention - checking for updates and building packages.
+
+### How do I install it?
+
+TL;DR
+
+```shell
+yay -S ahriman
+sudo ahriman -a x86_64 repo-setup --packager "ahriman bot <ahriman@example.com>" --repository "repository"
+systemctl enable --now ahriman@x86_64.timer
+```
+
+#### Long answer
+
+The idea is to install the package as usual, create working directory tree, create configuration for `sudo` and `devtools`. Detailed description of the setup instruction can be found [here](setup.md).
+
+### What does "architecture specific" mean? / How to configure for different architectures?
+
+Some sections can be configured per architecture. The service will merge architecture specific values into common settings. In order to specify settings for specific architecture you must point it in section name.
+
+For example, the section
+
+```ini
+[build]
+build_command = extra-x86_64-build
+```
+
+states that default build command is `extra-x86_64-build`. But if there is section
+
+```ini
+[build:i686]
+build_command = extra-i686-build
+```
+
+the `extra-i686-build` command will be used for `i686` architecture.
+
+### How to use reporter/upload settings?
+
+Normally you probably like to generate only one report for the specific type, e.g. only one email report. In order to do it you will need to have the following configuration:
+
+```ini
+[report]
+target = email
+
+[email]
+...
+```
+
+or in case of multiple architectures and _different_ reporting settings:
+
+```ini
+[report]
+target = email
+
+[email:i686]
+...
+
+[email:x86_64]
+...
+```
+
+But for some cases you would like to have multiple different reports with the same type (e.g. sending different templates to different addresses). For these cases you will need to specify section name in target and type in section, e.g. the following configuration can be used:
+
+```ini
+[report]
+target = email_1 email_2
+
+[email_1]
+type = email
+...
+
+[email_2]
+type = email
+...
+```
+
+### Okay, I've installed ahriman, how do I add new package?
+
+```shell
+sudo -u ahriman ahriman package-add ahriman --now
+```
+
+`--now` flag is totally optional and just run `repo-update` subcommand after the registering the new package, Thus the extended flow is the following:
+
+```shell
+sudo -u ahriman ahriman package-add ahriman
+sudo -u ahriman ahriman repo-update
+```
+
+### AUR is fine, but I would like to create package from local PKGBUILD
+
+TL;DR
+
+```shell
+sudo -u ahriman ahriman package-add /path/to/local/directory/with/PKGBUILD --now
+```
+
+Before using this command you will need to create local directory, put `PKGBUILD` there and generate `.SRCINFO` by using `makepkg --printsrcinfo > .SRCINFO` command. These packages will be stored locally and _will be ignored_ during automatic update; in order to update the package you will need to run `package-add` command again.
+
+### But I just wanted to change PKGBUILD from AUR a bit!
+
+Well it is supported also.
+
+1. Clone sources from AUR.
+2. Make changes you would like to (e.g. edit `PKGBUILD`, add external patches).
+3. Run `sudo -u ahriman ahriman patch-add /path/to/local/directory/with/PKGBUILD`.
+
+The last command will calculate diff from current tree to the `HEAD` and will store it locally. Patches will be applied on any package actions (e.g. it can be used for dependency management).
+
+### Package build fails because it cannot validate PGP signature of source files
+
+TL;DR
+
+```shell
+sudo -u ahriman ahriman key-import ...
+```
+
+### How do I check if there are new commits for VCS packages?
+
+Normally the service handles VCS packages correctly, but it requires additional dependencies:
+
+```shell
+pacman -S breezy darcs mercurial subversion
+```
+
+### I would like to remove package because it is no longer needed/moved to official repositories
+
+```shell
+sudo -u ahriman ahriman package-remove ahriman
+```
+
+Also, there is command `repo-remove-unknown` which checks packages in AUR and local storage and removes ones which have been removed.
+
+Remove commands also remove any package files (patches, caches etc).
+
+### There is new major release of %library-name%, how do I rebuild packages?
+
+TL;DR
+
+```shell
+sudo -u ahriman ahriman repo-rebuild --depends-on python
+```
+
+You can even rebuild the whole repository (which is particular useful in case if you would like to change packager) if you do not supply `--depends-on` option.
+
+However, note that you do not need to rebuild repository in case if you just changed signing option, just use `repo-sign` command instead. 
+
+### Hmm, I have packages built, but how can I use it?
+
+Add the following lines to your `pacman.conf`:
+
+```ini
+[repository]
+Server = file:///var/lib/ahriman/repository/x86_64
+```
+
+(You might need to add `SigLevel` option according to the pacman documentation.)
+
+
+### I would like to serve the repository
+
+Easy. For example, nginx configuration (without SSL) will look like:
+
+```
+server {
+    listen 80;
+    server_name repo.example.com;
+
+    location / {
+        autoindex on;
+        root /var/lib/ahriman/repository;
+    }
+}
+```
+
+Example of the status page configuration is the following (status service is using 8080 port):
+
+```
+server {
+    listen 80;
+    server_name builds.example.com;
+
+    location / {
+        proxy_set_header Host $host;
+        proxy_set_header X-Real-IP $remote_addr;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarder-Proto $scheme;
+
+        proxy_pass http://127.0.0.1:8080;
+    }
+}
+```
+
+## Docker image
+
+We provide official images which can be found under `arcan1s/ahriman` repository. Docker image is being updated on each master commit as well as on each version. If you would like to use last (probably unstable) build you can use `edge` tag or `latest` for any tagged versions; otherwise you can use any version tag available. 
+
+The default action (in case if no arguments provided) is `repo-update`. Basically the idea is to run container, e.g.:
+
+```shell
+docker run --privileged -v /path/to/local/repo:/var/lib/ahriman arcan1s/ahriman:latest
+```
+
+`--privileged` flag is required to make mount possible inside container. In addition, you can pass own configuration overrides by using the same `-v` flag, e.g.:
+
+```shell
+docker run -v /path/to/local/repo:/var/lib/ahriman -v /etc/ahriman.ini:/etc/ahriman.ini.d/10-overrides.ini arcan1s/ahriman:latest
+```
+
+By default, it runs `repo-update`, but it can be overwritten to any other command you would like to, e.g.:
+
+```shell
+docker run arcan1s/ahriman:latest package-add ahriman --now
+```
+
+For more details please refer to docker FAQ.
+
+### Environment variables
+
+The following environment variables are supported:
+
+* `AHRIMAN_ARCHITECTURE` - architecture of the repository, default is `x86_64`.
+* `AHRIMAN_DEBUG` - if set all commands will be logged to console.
+* `AHRIMAN_FORCE_ROOT` - force run ahriman as root instead of guessing by subcommand.
+* `AHRIMAN_HOST` - host for the web interface, default is `0.0.0.0`.
+* `AHRIMAN_OUTPUT` - controls logging handler, e.g. `syslog`, `console`. The name must be found in logging configuration. Note that if `syslog` (the default) handler is used you will need to mount `/dev/log` inside container because it is not available there.
+* `AHRIMAN_PACKAGER` - packager name from which packages will be built, default is `ahriman bot <ahriman@example.com>`.
+* `AHRIMAN_PORT` - HTTP server port if any, default is empty.
+* `AHRIMAN_REPOSITORY` - repository name, default is `aur-clone`.
+* `AHRIMAN_REPOSITORY_ROOT` - repository root. Because of filesystem rights it is required to override default repository root. By default, it uses `ahriman` directory inside ahriman's home, which can be passed as mount volume.
+* `AHRIMAN_USER` - ahriman user, usually must not be overwritten, default is `ahriman`. 
+
+You can pass any of these variables by using `-e` argument, e.g.:
+
+```shell
+docker run -e AHRIMAN_PORT=8080 arcan1s/ahriman:latest
+```
+
+### Web service setup
+
+Well for that you would need to have web container instance running forever; it can be achieved by the following command:
+
+```shell
+docker run -p 8080:8080 -e AHRIMAN_PORT=8080 -v /path/to/local/repo:/var/lib/ahriman arcan1s/ahriman:latest
+```
+
+Note about `AHRIMAN_PORT` environment variable which is required in order to enable web service. An additional port bind by `-p 8080:8080` is required to pass docker port outside of container.
+
+For every next container run use arguments `-e AHRIMAN_PORT=8080 --net=host`, e.g.:
+
+```shell
+docker run --privileged -e AHRIMAN_PORT=8080 --net=host -v /path/to/local/repo:/var/lib/ahriman arcan1s/ahriman:latest
+```
+
+## Remote synchronization
+
+### Wait I would like to use the repository from another server
+
+There are several choices:
+
+1. Easy and cheap, just share your local files through the internet, e.g. for `nginx`:
+   
+    ```
+    server {
+        location /x86_64 {
+            root /var/lib/ahriman/repository/x86_64;
+            autoindex on;
+        }
+    }
+    ```
+   
+2. You can also upload your packages using `rsync` to any available server. In order to use it you would need to configure ahriman first:
+    
+    ```ini
+    [upload]
+    target = rsync
+    
+    [rsync]
+    remote = 192.168.0.1:/srv/repo
+    ```
+   
+    After that just add `/srv/repo` to the `pacman.conf` as usual. You can also upload to S3 (e.g. `Server = https://s3.eu-central-1.amazonaws.com/repository/x86_64`) or to Github (e.g. `Server = https://github.com/ahriman/repository/releases/download/x86_64`).
+
+### How do I configure S3?
+
+1. Install dependencies:
+
+   ```shell
+   pacman -S python-boto3
+   ```
+
+3. Create a bucket.
+4. Create user with write access to the bucket:
+
+    ```
+    {
+        "Version": "2012-10-17",
+        "Statement": [
+            {
+                "Sid": "ListObjectsInBucket",
+                "Effect": "Allow",
+                "Action": [
+                    "s3:ListBucket"
+                ],
+                "Resource": [
+                    "arn:aws:s3:::repository"
+                ]
+            },
+            {
+                "Sid": "AllObjectActions",
+                "Effect": "Allow",
+                "Action": "s3:*Object",
+                "Resource": [
+                    "arn:aws:s3:::repository/*"
+                ]
+            }
+        ]
+    }
+    ```
+
+5. Create an API key for the user and store it.
+6. Configure the service as following:
+
+    ```ini
+    [upload]
+    target = s3
+
+    [s3]
+    access_key = ...
+    bucket = repository
+    region = eu-central-1
+    secret_key = ...
+    ```
+   
+### How do I configure Github?
+
+1. Create a repository.
+2. [Create API key](https://github.com/settings/tokens) with scope `public_repo`.
+3. Configure the service as following:
+
+    ```ini
+    [upload]
+    target = github
+
+    [github]
+    owner = ahriman
+    password = ...
+    repository = repository
+    username = ahriman
+    ```
+
+## Reporting
+
+### I would like to get report to email
+
+1. Install dependencies:
+
+   ```shell
+   yay -S python-jinja
+   ```
+   
+2. Configure the service:
+
+   ```ini
+   [report]
+   target = email
+   
+   [email]
+   host = smtp.example.com
+   link_path = http://example.com/x86_64
+   password = ...
+   port = 465
+   receivers = me@example.com
+   sender = me@example.com
+   user = me@example.com
+   ```
+   
+### I'm using synchronization to S3 and would like to generate index page
+
+1. Install dependencies:
+
+   ```shell
+   yay -S python-jinja
+   ```
+   
+2. Configure the service:
+   
+   ```ini
+   [report]
+   target = html
+   
+   [html]
+   path = /var/lib/ahriman/repository/x86_64/index.html
+   link_path = http://example.com/x86_64
+   ```
+   
+After these steps `index.html` file will be automatically synced to S3
+
+### I would like to get messages to my telegram account/channel
+
+1. It still requires additional dependencies:
+
+   ```shell
+   yay -S python-jinja
+   ```
+
+2. Register bot in telegram. You can do it by talking with [@BotFather](https://t.me/botfather). For more details please refer to [official documentation](https://core.telegram.org/bots).
+
+3. Optionally (if you want to post message in chat):
+
+   1. Create telegram channel. 
+   2. Invite your bot into the channel.
+   3. Make your channel public
+
+4. Get chat id if you want to use by numerical id or just use id prefixed with `@` (e.g. `@ahriman`). If you are not using chat the chat id is your user id. If you don't want to make channel public you can use [this guide](https://stackoverflow.com/a/33862907).
+
+5. Configure the service:
+
+   ```ini
+   [report]
+   target = telegram
+   
+   [telegram]
+   api_key = aaAAbbBBccCC
+   chat_id = @ahriman
+   link_path = http://example.com/x86_64
+   ```
+   
+   `api_key` is the one sent by [@BotFather](https://t.me/botfather), `chat_id` is the value retrieved from previous step.
+
+If you did everything fine you should receive the message with the next update. Quick credentials check can be done by using the following command:
+
+```shell
+curl 'https://api.telegram.org/bot${CHAT_ID}/sendMessage?chat_id=${API_KEY}&text=hello'
+```
+
+(replace `${CHAT_ID}` and `${API_KEY}` with the values from configuration).
+
+## Web service
+
+### Readme mentions web interface, how do I use it?
+
+1. Install dependencies:
+
+   ```shell
+   yay -S python-aiohttp python-aiohttp-jinja2
+   ```
+
+2. Configure service:
+
+   ```ini
+   [web]
+   port = 8080
+   ```
+
+3. Start the web service `systemctl enable --now ahriman-web@x86_64`.
+
+### I would like to limit user access to the status page
+
+1. Install dependencies 😊:
+   
+   ```shell
+   yay -S python-aiohttp-security python-aiohttp-session python-cryptography
+   ```
+
+2. Configure the service to enable authorization:
+
+   ```ini
+   [auth]
+   target = configuration
+   ```
+   
+3. Create user for the service:
+
+   ```shell
+   sudo -u ahriman ahriman user-add --as-service -r write api
+   ```
+   
+   This command will ask for the password, just type it in stdin; _do not_ leave the field blank, user will not be able to authorize.
+
+4. Create end-user `sudo -u ahriman ahriman user-add -r write my-first-user` with password.
+5. Restart web service `systemctl restart ahriman-web@x86_64`.
+
+### I would like to use OAuth
+
+1. Create OAuth web application, download its `client_id` and `client_secret`.
+2. Guess what? Install dependencies:
+
+   ```shell
+   yay -S python-aiohttp-security python-aiohttp-session python-cryptography python-aioauth-client
+   ```
+   
+3. Configure the service:
+
+   ```ini
+   [auth]
+   target = oauth
+   client_id = ...
+   client_secret = ...
+   
+   [web]
+   address = https://example.com
+   ```
+   
+   Configure `oauth_provider` and `oauth_scopes` in case if you would like to use different from Google provider. Scope must grant access to user email. `web.address` is required to make callback URL available from internet.
+
+4. Create service user:
+
+   ```shell
+   sudo -u ahriman ahriman user-add --as-service -r write api
+   ```
+
+5. Create end-user `sudo -u ahriman ahriman user-add -r write my-first-user`. When it will ask for the password leave it blank.
+6. Restart web service `systemctl restart ahriman-web@x86_64`.
+
+## Backup and restore
+
+The service provides several commands aim to do easy repository backup and restore. If you would like to move repository from the server `server1.example.com` to another `server2.example.com` you have to perform the following steps:
+
+1. On the source server `server1.example.com` run `repo-backup` command, e.g.:
+
+   ```shell
+   sudo ahriman repo-backup /tmp/repo.tar.gz
+   ```
+   
+   This command will pack all configuration files together with database file into the archive specified as command line argument (i.e. `/tmp/repo.tar.gz`). In addition it will also archive `cache` directory (the one which contains local clones used by e.g. local packages) and `.gnupg` of the `ahriman` user.
+
+2. Copy created archive from source server `server1.example.com` to target `server2.example.com`.
+
+3. Install ahriman as usual on the target server `server2.example.com` if you didn't yet.
+
+4. Extract archive e.g. by using subcommand:
+   
+   ```shell
+   sudo ahriman repo-restore /tmp/repo.tar.gz
+   ```
+   
+   An additional argument `-o`/`--output` can be used to specify extraction root (`/` by default).
+
+5. Rebuild repository:
+
+   ```shell
+   sudo -u ahriman ahriman repo-rebuild --from-database
+   ```
+
+## Other topics
+
+### How does it differ from %another-manager%?
+
+Short answer - I do not know.
+
+#### [archrepo2](https://github.com/lilydjwg/archrepo2)
+
+Don't know, haven't tried it. But it lacks of documentation at least.
+
+* Web interface.
+* No synchronization and reporting.
+* `archrepo2` actively uses direct shell calls and `yaourt` components.
+* It has constantly running process instead of timer process (it is not pro or con).
+
+#### [repoctl](https://github.com/cassava/repoctl)
+
+* Web interface.
+* No reporting.
+* Local packages and patches support.
+* Some actions are not fully automated (e.g. package update still requires manual intervention for the build itself). 
+* `repoctl` has better AUR interaction features. With colors!
+* `repoctl` has much easier configuration and even completion.
+* `repoctl` is able to store old packages.
+* Ability to host repository from same command vs external services (e.g. nginx) in `ahriman`.
+
+#### [repo-scripts](https://github.com/arcan1s/repo-scripts)
+
+Though originally I've created ahriman by trying to improve the project, it still lacks a lot of features:
+
+* Web interface.
+* Better reporting with template support.
+* Synchronization features (there was only `rsync` based).
+* Local packages and patches support.
+* No dependency management.
+* And so on.
+
+`repo-scripts` also have bad architecture and bad quality code and uses out-of-dated `yaourt` and `package-query`.
+
+#### [toolbox](https://github.com/chaotic-aur/toolbox)
+
+It is automation tools for `repoctl` mentioned above. Except for using shell it looks pretty cool and also offers some additional features like patches, remote synchronization (isn't it?) and reporting.
+
+### I would like to check service logs
+
+By default, the service writes logs to `/dev/log` which can be accessed by using `journalctl` command (logs are written to the journal of the user under which command is run).
+
+You can also edit configuration and forward logs to `stderr`, just change `handlers` value, e.g.:
+
+```shell
+sed -i 's/handlers = syslog_handler/handlers = console_handler/g' /etc/ahriman.ini.d/logging.ini
+```
+
+You can even configure logging as you wish, but kindly refer to python `logging` module [configuration](https://docs.python.org/3/library/logging.config.html).
+
+### Html customization
+
+It is possible to customize html templates. In order to do so, create files somewhere (refer to Jinja2 documentation and the service source code for available parameters) and put `template_path` to configuration pointing to this directory.
+
+### I did not find my question
+
+[Create an issue](https://github.com/arcan1s/ahriman/issues) with type **Question**.

docs/faq.rst

@@ -1,703 +0,0 @@
-FAQ
-===
-
-General topics
---------------
-
-What is the purpose of the project?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-This project has been created in order to maintain self-hosted Arch Linux user repository without manual intervention - checking for updates and building packages.
-
-How do I install it?
-^^^^^^^^^^^^^^^^^^^^
-
-TL;DR
-
-.. code-block:: shell
-
-   yay -S ahriman
-   sudo ahriman -a x86_64 repo-setup --packager "ahriman bot <ahriman@example.com>" --repository "repository"
-   systemctl enable --now ahriman@x86_64.timer
-
-Long answer
-"""""""""""
-
-The idea is to install the package as usual, create working directory tree, create configuration for ``sudo`` and ``devtools``. Detailed description of the setup instruction can be found :doc:`here <setup>`.
-
-What does "architecture specific" mean? / How to configure for different architectures?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Some sections can be configured per architecture. The service will merge architecture specific values into common settings. In order to specify settings for specific architecture you must point it in section name.
-
-For example, the section
-
-.. code-block:: ini
-
-   [build]
-   build_command = extra-x86_64-build
-
-states that default build command is ``extra-x86_64-build``. But if there is section
-
-.. code-block:: ini
-
-   [build:i686]
-   build_command = extra-i686-build
-
-the ``extra-i686-build`` command will be used for ``i686`` architecture.
-
-How to use reporter/upload settings?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Normally you probably like to generate only one report for the specific type, e.g. only one email report. In order to do it you will need to have the following configuration:
-
-.. code-block:: ini
-
-   [report]
-   target = email
-
-   [email]
-   ...
-
-or in case of multiple architectures and *different* reporting settings:
-
-.. code-block:: ini
-
-   [report]
-   target = email
-
-   [email:i686]
-   ...
-
-   [email:x86_64]
-   ...
-
-But for some cases you would like to have multiple different reports with the same type (e.g. sending different templates to different addresses). For these cases you will need to specify section name in target and type in section, e.g. the following configuration can be used:
-
-.. code-block:: ini
-
-   [report]
-   target = email_1 email_2
-
-   [email_1]
-   type = email
-   ...
-
-   [email_2]
-   type = email
-   ...
-
-Okay, I've installed ahriman, how do I add new package?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. code-block:: shell
-
-   sudo -u ahriman ahriman package-add ahriman --now
-
-``--now`` flag is totally optional and just run ``repo-update`` subcommand after the registering the new package, Thus the extended flow is the following:
-
-.. code-block:: shell
-
-   sudo -u ahriman ahriman package-add ahriman
-   sudo -u ahriman ahriman repo-update
-
-AUR is fine, but I would like to create package from local PKGBUILD
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-TL;DR
-
-.. code-block:: shell
-
-   sudo -u ahriman ahriman package-add /path/to/local/directory/with/PKGBUILD --now
-
-Before using this command you will need to create local directory, put ``PKGBUILD`` there and generate ``.SRCINFO`` by using ``makepkg --printsrcinfo > .SRCINFO`` command. These packages will be stored locally and *will be ignored* during automatic update; in order to update the package you will need to run ``package-add`` command again.
-
-But I just wanted to change PKGBUILD from AUR a bit!
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Well it is supported also.
-
-#. Clone sources from AUR.
-#. Make changes you would like to (e.g. edit ``PKGBUILD``\ , add external patches).
-#. Run ``sudo -u ahriman ahriman patch-add /path/to/local/directory/with/PKGBUILD``.
-
-The last command will calculate diff from current tree to the ``HEAD`` and will store it locally. Patches will be applied on any package actions (e.g. it can be used for dependency management).
-
-Hey, I would like to rebuild the official repository package
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-So it is the same as adding any other package, but due to restrictions you must specify source explicitly, e.g.:
-
-.. code-block:: shell
-
-   sudo -u ahriman ahriman package-add pacmann -s repository
-
-Package build fails because it cannot validate PGP signature of source files
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-TL;DR
-
-.. code-block:: shell
-
-   sudo -u ahriman ahriman key-import ...
-
-How do I check if there are new commits for VCS packages?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Normally the service handles VCS packages correctly, but it requires additional dependencies:
-
-.. code-block:: shell
-
-   pacman -S breezy darcs mercurial subversion
-
-I would like to remove package because it is no longer needed/moved to official repositories
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-.. code-block:: shell
-
-   sudo -u ahriman ahriman package-remove ahriman
-
-Also, there is command ``repo-remove-unknown`` which checks packages in AUR and local storage and removes ones which have been removed.
-
-Remove commands also remove any package files (patches, caches etc).
-
-There is new major release of %library-name%, how do I rebuild packages?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-TL;DR
-
-.. code-block:: shell
-
-   sudo -u ahriman ahriman repo-rebuild --depends-on python
-
-You can even rebuild the whole repository (which is particular useful in case if you would like to change packager) if you do not supply ``--depends-on`` option.
-
-However, note that you do not need to rebuild repository in case if you just changed signing option, just use ``repo-sign`` command instead. 
-
-Hmm, I have packages built, but how can I use it?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Add the following lines to your ``pacman.conf``\ :
-
-.. code-block:: ini
-
-   [repository]
-   Server = file:///var/lib/ahriman/repository/x86_64
-
-(You might need to add ``SigLevel`` option according to the pacman documentation.)
-
-I would like to serve the repository
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Easy. For example, nginx configuration (without SSL) will look like:
-
-.. code-block::
-
-   server {
-       listen 80;
-       server_name repo.example.com;
-
-       location / {
-           autoindex on;
-           root /var/lib/ahriman/repository;
-       }
-   }
-
-Example of the status page configuration is the following (status service is using 8080 port):
-
-.. code-block::
-
-   server {
-       listen 80;
-       server_name builds.example.com;
-
-       location / {
-           proxy_set_header Host $host;
-           proxy_set_header X-Real-IP $remote_addr;
-           proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-           proxy_set_header X-Forwarder-Proto $scheme;
-
-           proxy_pass http://127.0.0.1:8080;
-       }
-   }
-
-Docker image
-------------
-
-We provide official images which can be found under ``arcan1s/ahriman`` repository. Docker image is being updated on each master commit as well as on each version. If you would like to use last (probably unstable) build you can use ``edge`` tag or ``latest`` for any tagged versions; otherwise you can use any version tag available. 
-
-The default action (in case if no arguments provided) is ``repo-update``. Basically the idea is to run container, e.g.:
-
-.. code-block:: shell
-
-   docker run --privileged -v /path/to/local/repo:/var/lib/ahriman arcan1s/ahriman:latest
-
-``--privileged`` flag is required to make mount possible inside container. In addition, you can pass own configuration overrides by using the same ``-v`` flag, e.g.:
-
-.. code-block:: shell
-
-   docker run -v /path/to/local/repo:/var/lib/ahriman -v /etc/ahriman.ini:/etc/ahriman.ini.d/10-overrides.ini arcan1s/ahriman:latest
-
-By default, it runs ``repo-update``\ , but it can be overwritten to any other command you would like to, e.g.:
-
-.. code-block:: shell
-
-   docker run arcan1s/ahriman:latest package-add ahriman --now
-
-For more details please refer to docker FAQ.
-
-Environment variables
-^^^^^^^^^^^^^^^^^^^^^
-
-The following environment variables are supported:
-
-* ``AHRIMAN_ARCHITECTURE`` - architecture of the repository, default is ``x86_64``.
-* ``AHRIMAN_DEBUG`` - if set all commands will be logged to console.
-* ``AHRIMAN_FORCE_ROOT`` - force run ahriman as root instead of guessing by subcommand.
-* ``AHRIMAN_HOST`` - host for the web interface, default is ``0.0.0.0``.
-* ``AHRIMAN_OUTPUT`` - controls logging handler, e.g. ``syslog``\ , ``console``. The name must be found in logging configuration. Note that if ``syslog`` (the default) handler is used you will need to mount ``/dev/log`` inside container because it is not available there.
-* ``AHRIMAN_PACKAGER`` - packager name from which packages will be built, default is ``ahriman bot <ahriman@example.com>``.
-* ``AHRIMAN_PORT`` - HTTP server port if any, default is empty.
-* ``AHRIMAN_REPOSITORY`` - repository name, default is ``aur-clone``.
-* ``AHRIMAN_REPOSITORY_ROOT`` - repository root. Because of filesystem rights it is required to override default repository root. By default, it uses ``ahriman`` directory inside ahriman's home, which can be passed as mount volume.
-* ``AHRIMAN_USER`` - ahriman user, usually must not be overwritten, default is ``ahriman``. 
-
-You can pass any of these variables by using ``-e`` argument, e.g.:
-
-.. code-block:: shell
-
-   docker run -e AHRIMAN_PORT=8080 arcan1s/ahriman:latest
-
-Web service setup
-^^^^^^^^^^^^^^^^^
-
-Well for that you would need to have web container instance running forever; it can be achieved by the following command:
-
-.. code-block:: shell
-
-   docker run -p 8080:8080 -e AHRIMAN_PORT=8080 -v /path/to/local/repo:/var/lib/ahriman arcan1s/ahriman:latest
-
-Note about ``AHRIMAN_PORT`` environment variable which is required in order to enable web service. An additional port bind by ``-p 8080:8080`` is required to pass docker port outside of container.
-
-For every next container run use arguments ``-e AHRIMAN_PORT=8080 --net=host``\ , e.g.:
-
-.. code-block:: shell
-
-   docker run --privileged -e AHRIMAN_PORT=8080 --net=host -v /path/to/local/repo:/var/lib/ahriman arcan1s/ahriman:latest
-
-Remote synchronization
-----------------------
-
-Wait I would like to use the repository from another server
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-There are several choices:
-
-#. 
-   Easy and cheap, just share your local files through the internet, e.g. for ``nginx``\ :
-
-   .. code-block::
-
-       server {
-           location /x86_64 {
-               root /var/lib/ahriman/repository/x86_64;
-               autoindex on;
-           }
-       }
-
-#. 
-   You can also upload your packages using ``rsync`` to any available server. In order to use it you would need to configure ahriman first:
-
-   .. code-block:: ini
-
-       [upload]
-       target = rsync
-
-       [rsync]
-       remote = 192.168.0.1:/srv/repo
-
-   After that just add ``/srv/repo`` to the ``pacman.conf`` as usual. You can also upload to S3 (e.g. ``Server = https://s3.eu-central-1.amazonaws.com/repository/x86_64``\ ) or to Github (e.g. ``Server = https://github.com/ahriman/repository/releases/download/x86_64``\ ).
-
-How do I configure S3?
-^^^^^^^^^^^^^^^^^^^^^^
-
-#. 
-   Install dependencies:
-
-   .. code-block:: shell
-
-      pacman -S python-boto3
-
-#. 
-   Create a bucket.
-
-#. 
-   Create user with write access to the bucket:
-
-   .. code-block::
-
-       {
-           "Version": "2012-10-17",
-           "Statement": [
-               {
-                   "Sid": "ListObjectsInBucket",
-                   "Effect": "Allow",
-                   "Action": [
-                       "s3:ListBucket"
-                   ],
-                   "Resource": [
-                       "arn:aws:s3:::repository"
-                   ]
-               },
-               {
-                   "Sid": "AllObjectActions",
-                   "Effect": "Allow",
-                   "Action": "s3:*Object",
-                   "Resource": [
-                       "arn:aws:s3:::repository/*"
-                   ]
-               }
-           ]
-       }
-
-#. 
-   Create an API key for the user and store it.
-
-#. 
-   Configure the service as following:
-
-   .. code-block:: ini
-
-       [upload]
-       target = s3
-
-       [s3]
-       access_key = ...
-       bucket = repository
-       region = eu-central-1
-       secret_key = ...
-
-How do I configure Github?
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-#. 
-   Create a repository.
-#. 
-   `Create API key <https://github.com/settings/tokens>`_ with scope ``public_repo``.
-#. 
-   Configure the service as following:
-
-   .. code-block:: ini
-
-       [upload]
-       target = github
-
-       [github]
-       owner = ahriman
-       password = ...
-       repository = repository
-       username = ahriman
-
-Reporting
----------
-
-I would like to get report to email
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-#. 
-   Install dependencies:
-
-   .. code-block:: shell
-
-      yay -S python-jinja
-
-#. 
-   Configure the service:
-
-   .. code-block:: ini
-
-      [report]
-      target = email
-
-      [email]
-      host = smtp.example.com
-      link_path = http://example.com/x86_64
-      password = ...
-      port = 465
-      receivers = me@example.com
-      sender = me@example.com
-      user = me@example.com
-
-I'm using synchronization to S3 and would like to generate index page
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-#. 
-   Install dependencies:
-
-   .. code-block:: shell
-
-      yay -S python-jinja
-
-#. 
-   Configure the service:
-
-   .. code-block:: ini
-
-      [report]
-      target = html
-
-      [html]
-      path = /var/lib/ahriman/repository/x86_64/index.html
-      link_path = http://example.com/x86_64
-
-After these steps ``index.html`` file will be automatically synced to S3
-
-I would like to get messages to my telegram account/channel
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-#. 
-   It still requires additional dependencies:
-
-   .. code-block:: shell
-
-      yay -S python-jinja
-
-#. 
-   Register bot in telegram. You can do it by talking with `@BotFather <https://t.me/botfather>`_. For more details please refer to `official documentation <https://core.telegram.org/bots>`_.
-
-#. 
-   Optionally (if you want to post message in chat):
-
-
-   #. Create telegram channel. 
-   #. Invite your bot into the channel.
-   #. Make your channel public
-
-#. 
-   Get chat id if you want to use by numerical id or just use id prefixed with ``@`` (e.g. ``@ahriman``\ ). If you are not using chat the chat id is your user id. If you don't want to make channel public you can use `this guide <https://stackoverflow.com/a/33862907>`_.
-
-#. 
-   Configure the service:
-
-   .. code-block:: ini
-
-      [report]
-      target = telegram
-
-      [telegram]
-      api_key = aaAAbbBBccCC
-      chat_id = @ahriman
-      link_path = http://example.com/x86_64
-
-   ``api_key`` is the one sent by `@BotFather <https://t.me/botfather>`_\ , ``chat_id`` is the value retrieved from previous step.
-
-If you did everything fine you should receive the message with the next update. Quick credentials check can be done by using the following command:
-
-.. code-block:: shell
-
-   curl 'https://api.telegram.org/bot${CHAT_ID}/sendMessage?chat_id=${API_KEY}&text=hello'
-
-(replace ``${CHAT_ID}`` and ``${API_KEY}`` with the values from configuration).
-
-Web service
------------
-
-Readme mentions web interface, how do I use it?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-#. 
-   Install dependencies:
-
-   .. code-block:: shell
-
-      yay -S python-aiohttp python-aiohttp-jinja2
-
-#. 
-   Configure service:
-
-   .. code-block:: ini
-
-      [web]
-      port = 8080
-
-#. 
-   Start the web service ``systemctl enable --now ahriman-web@x86_64``.
-
-I would like to limit user access to the status page
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-#. 
-   Install dependencies 😊:
-
-   .. code-block:: shell
-
-      yay -S python-aiohttp-security python-aiohttp-session python-cryptography
-
-#. 
-   Configure the service to enable authorization:
-
-   .. code-block:: ini
-
-      [auth]
-      target = configuration
-
-#. 
-   Create user for the service:
-
-   .. code-block:: shell
-
-      sudo -u ahriman ahriman user-add --as-service -r write api
-
-   This command will ask for the password, just type it in stdin; *do not* leave the field blank, user will not be able to authorize.
-
-#. 
-   Create end-user ``sudo -u ahriman ahriman user-add -r write my-first-user`` with password.
-
-#. Restart web service ``systemctl restart ahriman-web@x86_64``.
-
-I would like to use OAuth
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-#. 
-   Create OAuth web application, download its ``client_id`` and ``client_secret``.
-#. 
-   Guess what? Install dependencies:
-
-   .. code-block:: shell
-
-      yay -S python-aiohttp-security python-aiohttp-session python-cryptography python-aioauth-client
-
-#. 
-   Configure the service:
-
-   .. code-block:: ini
-
-      [auth]
-      target = oauth
-      client_id = ...
-      client_secret = ...
-
-      [web]
-      address = https://example.com
-
-   Configure ``oauth_provider`` and ``oauth_scopes`` in case if you would like to use different from Google provider. Scope must grant access to user email. ``web.address`` is required to make callback URL available from internet.
-
-#. 
-   Create service user:
-
-   .. code-block:: shell
-
-      sudo -u ahriman ahriman user-add --as-service -r write api
-
-#. 
-   Create end-user ``sudo -u ahriman ahriman user-add -r write my-first-user``. When it will ask for the password leave it blank.
-
-#. Restart web service ``systemctl restart ahriman-web@x86_64``.
-
-Backup and restore
-------------------
-
-The service provides several commands aim to do easy repository backup and restore. If you would like to move repository from the server ``server1.example.com`` to another ``server2.example.com`` you have to perform the following steps:
-
-#. 
-   On the source server ``server1.example.com`` run ``repo-backup`` command, e.g.:
-
-   .. code-block:: shell
-
-      sudo ahriman repo-backup /tmp/repo.tar.gz
-
-   This command will pack all configuration files together with database file into the archive specified as command line argument (i.e. ``/tmp/repo.tar.gz``\ ). In addition it will also archive ``cache`` directory (the one which contains local clones used by e.g. local packages) and ``.gnupg`` of the ``ahriman`` user.
-
-#. 
-   Copy created archive from source server ``server1.example.com`` to target ``server2.example.com``.
-
-#. 
-   Install ahriman as usual on the target server ``server2.example.com`` if you didn't yet.
-
-#. 
-   Extract archive e.g. by using subcommand:
-
-   .. code-block:: shell
-
-      sudo ahriman repo-restore /tmp/repo.tar.gz
-
-   An additional argument ``-o``\ /\ ``--output`` can be used to specify extraction root (\ ``/`` by default).
-
-#. 
-   Rebuild repository:
-
-   .. code-block:: shell
-
-      sudo -u ahriman ahriman repo-rebuild --from-database
-
-Other topics
-------------
-
-How does it differ from %another-manager%?
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Short answer - I do not know.
-
-`archrepo2 <https://github.com/lilydjwg/archrepo2>`_
-""""""""""""""""""""""""""""""""""""""""""""""""""""
-
-Don't know, haven't tried it. But it lacks of documentation at least.
-
-* Web interface.
-* No synchronization and reporting.
-* ``archrepo2`` actively uses direct shell calls and ``yaourt`` components.
-* It has constantly running process instead of timer process (it is not pro or con).
-
-`repoctl <https://github.com/cassava/repoctl>`_
-"""""""""""""""""""""""""""""""""""""""""""""""
-
-* Web interface.
-* No reporting.
-* Local packages and patches support.
-* Some actions are not fully automated (e.g. package update still requires manual intervention for the build itself). 
-* ``repoctl`` has better AUR interaction features. With colors!
-* ``repoctl`` has much easier configuration and even completion.
-* ``repoctl`` is able to store old packages.
-* Ability to host repository from same command vs external services (e.g. nginx) in ``ahriman``.
-
-`repo-scripts <https://github.com/arcan1s/repo-scripts>`_
-"""""""""""""""""""""""""""""""""""""""""""""""""""""""""
-
-Though originally I've created ahriman by trying to improve the project, it still lacks a lot of features:
-
-* Web interface.
-* Better reporting with template support.
-* Synchronization features (there was only ``rsync`` based).
-* Local packages and patches support.
-* No dependency management.
-* And so on.
-
-``repo-scripts`` also have bad architecture and bad quality code and uses out-of-dated ``yaourt`` and ``package-query``.
-
-`toolbox <https://github.com/chaotic-aur/toolbox>`_
-"""""""""""""""""""""""""""""""""""""""""""""""""""
-
-It is automation tools for ``repoctl`` mentioned above. Except for using shell it looks pretty cool and also offers some additional features like patches, remote synchronization (isn't it?) and reporting.
-
-I would like to check service logs
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-By default, the service writes logs to ``/dev/log`` which can be accessed by using ``journalctl`` command (logs are written to the journal of the user under which command is run).
-
-You can also edit configuration and forward logs to ``stderr``\ , just change ``handlers`` value, e.g.:
-
-.. code-block:: shell
-
-   sed -i 's/handlers = syslog_handler/handlers = console_handler/g' /etc/ahriman.ini.d/logging.ini
-
-You can even configure logging as you wish, but kindly refer to python ``logging`` module `configuration <https://docs.python.org/3/library/logging.config.html>`_.
-
-Html customization
-^^^^^^^^^^^^^^^^^^
-
-It is possible to customize html templates. In order to do so, create files somewhere (refer to Jinja2 documentation and the service source code for available parameters) and put ``template_path`` to configuration pointing to this directory.
-
-I did not find my question
-^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-`Create an issue <https://github.com/arcan1s/ahriman/issues>`_ with type **Question**.

docs/index.rst

@@ -1,37 +0,0 @@
-Welcome to ahriman's documentation!
-===================================
-
-Wrapper for managing custom repository inspired by `repo-scripts <https://github.com/arcan1s/repo-scripts>`_.
-
-Features
---------
-
-* Install-configure-forget manager for own repository.
-* Multi-architecture support.
-* VCS packages support.
-* Sign support with gpg (repository, package, per package settings).
-* Synchronization to remote services (rsync, s3 and github) and report generation (email, html, telegram).
-* Dependency manager.
-* Ability to patch AUR packages and even create package from local PKGBUILDs.
-* Repository status interface with optional authorization and control options.
-
-Contents
---------
-
-.. toctree::
-   :maxdepth: 2
-
-   setup
-   configuration
-   command-line
-   faq
-   architecture
-   advanced-usage
-   modules
-
-Indices and tables
-------------------
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

docs/modules.rst

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

docs/setup.md

@@ -0,0 +1,66 @@
+# Setup instructions
+
+1. Install package as usual.
+2. Change settings if required, see [configuration reference](configuration.md) for more details.
+3. TL;DR
+
+   ```shell
+   sudo ahriman -a x86_64 repo-setup ...
+   ```
+   
+   `repo-setup` literally does the following steps:
+
+   1. Create `/var/lib/ahriman/.makepkg.conf` with `makepkg.conf` overrides if required (at least you might want to set `PACKAGER`):
+
+       ```shell
+       echo 'PACKAGER="John Doe <john@doe.com>"' | sudo -u ahriman tee -a /var/lib/ahriman/.makepkg.conf
+       ```
+
+   2. Configure build tools (it is required for correct dependency management system):
+
+       1. 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`).
+       2. Create configuration file, e.g. `cp /usr/share/devtools/pacman-{extra,ahriman}.conf` (same as previous `pacman-{name}.conf`).
+       3. Change configuration file, add your own repository, add multilib repository etc;
+       4. Set `build_command` option to point to your command.
+       5. 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
+       ```
+
+4. Start and enable `ahriman@.timer` via `systemctl`:
+
+    ```shell
+    systemctl enable --now ahriman@x86_64.timer
+    ```
+
+5. Start and enable status page:
+
+    ```shell
+    systemctl enable --now ahriman-web@x86_64
+    ```
+
+6. Add packages by using `ahriman package-add {package}` command:
+
+    ```shell
+    sudo -u ahriman ahriman -a x86_64 package-add ahriman --now
+    ```
+
+## User creation
+
+`user-add` subcommand is recommended for new user creation.

docs/setup.rst

@@ -1,76 +0,0 @@
-Initial setup
-=============
-
-#. 
-   Install package as usual.
-#. 
-   Change settings if required, see :doc:`configuration reference <configuration>` for more details.
-#.
-   TL;DR
-
-   .. code-block:: shell
-
-      sudo ahriman -a x86_64 repo-setup ...
-
-   ``repo-setup`` literally does the following steps:
-
-   #.
-      Create ``/var/lib/ahriman/.makepkg.conf`` with ``makepkg.conf`` overrides if required (at least you might want to set ``PACKAGER``\ ):
-
-      .. code-block:: shell
-
-          echo 'PACKAGER="John Doe <john@doe.com>"' | sudo -u ahriman tee -a /var/lib/ahriman/.makepkg.conf
-
-   #.
-      Configure build tools (it is required for correct dependency management system):
-
-      #. 
-         Create build command, 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;
-      #. 
-         Set ``build_command`` option to point to your command.
-      #.
-         Configure ``/etc/sudoers.d/ahriman`` to allow running command without a password.
-
-         .. code-block:: 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``\ :
-
-   .. code-block:: shell
-
-       systemctl enable --now ahriman@x86_64.timer
-
-#. 
-   Start and enable status page:
-
-   .. code-block:: shell
-
-       systemctl enable --now ahriman-web@x86_64
-
-#. 
-   Add packages by using ``ahriman package-add {package}`` command:
-
-   .. code-block:: shell
-
-       sudo -u ahriman ahriman -a x86_64 package-add ahriman --now

package/archlinux/PKGBUILD

@@ -1,7 +1,7 @@
 # Maintainer: Evgeniy Alekseev
 
 pkgname='ahriman'
-pkgver=2.0.0rc9
+pkgver=2.0.0rc7
 pkgrel=1
 pkgdesc="ArcH Linux ReposItory MANager"
 arch=('any')

package/share/ahriman/settings/ahriman.ini

@@ -4,6 +4,7 @@ logging = ahriman.ini.d/logging.ini
 database = /var/lib/ahriman/ahriman.db
 
 [alpm]
+aur_url = https://aur.archlinux.org
 database = /var/lib/pacman
 repositories = core extra community multilib
 root = /

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

@@ -74,7 +74,7 @@
                     {% for package in packages %}
                         <tr data-package-base="{{ package.base }}">
                             <td data-checkbox="true"></td>
-                            <td>{% if package.web_url is not none %}<a href="{{ package.web_url }}" title="{{ package.base }}">{{ package.base }}</a>{% else %}{{ package.base }}{% endif %}</td>
+                            <td><a href="{{ package.web_url }}" title="{{ package.base }}">{{ package.base }}</a></td>
                             <td>{{ package.version }}</td>
                             <td>{{ package.packages|join("<br>"|safe) }}</td>
                             <td>{{ package.groups|join("<br>"|safe) }}</td>

package/share/ahriman/templates/repo-index.jinja2

@@ -85,9 +85,6 @@ SigLevel = Database{% if has_repo_signed %}Required{% else %}Never{% endif %} Pa
                         <li><a class="nav-link" href="{{ homepage }}" title="homepage">homepage</a></li>
                     {% endif %}
                 </ul>
-                <ul class="nav">
-                    <li><a class="nav-link" href="https://github.com/arcan1s/ahriman" title="sources">ahriman</a></li>
-                </ul>
             </footer>
         </div>
 

setup.py

@@ -31,6 +31,7 @@ setup(
     install_requires=[
         "inflection",
         "passlib",
+        "pyalpm",
         "requests",
         "srcinfo",
     ],
@@ -92,19 +93,6 @@ setup(
             "mypy",
             "pylint",
         ],
-        "docs": [
-            "Sphinx",
-            "argparse-manpage",
-            "pydeps",
-            "sphinx-argparse",
-            "sphinxcontrib-napoleon",
-        ],
-        # FIXME technically this dependency is required, but in some cases we do not have access to
-        # the libalpm which is required in order to install the package. Thus in case if we do not
-        # really need to run the application we can move it to "optional" dependencies
-        "pacman": [
-            "pyalpm",
-        ],
         "s3": [
             "boto3",
         ],

src/ahriman/application/ahriman.py

@@ -22,7 +22,7 @@ import sys
 import tempfile
 
 from pathlib import Path
-from typing import List, TypeVar
+from typing import TypeVar
 
 from ahriman import version
 from ahriman.application import handlers
@@ -33,9 +33,6 @@ from ahriman.models.sign_settings import SignSettings
 from ahriman.models.user_access import UserAccess
 
 
-__all__: List[str] = []
-
-
 # this workaround is for several things
 # firstly python devs don't think that is it error and asking you for workarounds https://bugs.python.org/issue41592
 # secondly linters don't like when you are importing private members
@@ -327,7 +324,7 @@ def _set_patch_add_parser(root: SubParserAction) -> argparse.ArgumentParser:
     parser = root.add_parser("patch-add", help="add patch set", description="create or update source patches",
                              epilog="In order to add a patch set for the package you will need to clone "
                                     "the AUR package manually, add required changes (e.g. external patches, "
-                                    "edit PKGBUILD) and run command, e.g. ``ahriman patch path/to/directory``. "
+                                    "edit PKGBUILD) and run command, e.g. `ahriman patch path/to/directory`. "
                                     "By default it tracks *.patch and *.diff files, but this behavior can be changed "
                                     "by using --track option",
                              formatter_class=_formatter)
@@ -664,7 +661,7 @@ def _set_user_add_parser(root: SubParserAction) -> argparse.ArgumentParser:
     parser.add_argument("-r", "--role", help="user access level",
                         type=UserAccess, choices=UserAccess, default=UserAccess.Read)
     parser.add_argument("-s", "--secure", help="set file permissions to user-only", action="store_true")
-    parser.set_defaults(handler=handlers.Users, action=Action.Update, architecture=[""], lock=None, no_report=True,
+    parser.set_defaults(handler=handlers.User, action=Action.Update, architecture=[""], lock=None, no_report=True,
                         quiet=True, unsafe=True)
     return parser
 
@@ -685,7 +682,7 @@ def _set_user_list_parser(root: SubParserAction) -> argparse.ArgumentParser:
     parser.add_argument("username", help="filter users by username", nargs="?")
     parser.add_argument("-e", "--exit-code", help="return non-zero exit status if result is empty", action="store_true")
     parser.add_argument("-r", "--role", help="filter users by role", type=UserAccess, choices=UserAccess)
-    parser.set_defaults(handler=handlers.Users, action=Action.List, architecture=[""], lock=None, no_report=True,  # nosec
+    parser.set_defaults(handler=handlers.User, action=Action.List, architecture=[""], lock=None, no_report=True,  # nosec
                         password="", quiet=True, unsafe=True)
     return parser
 
@@ -705,7 +702,7 @@ def _set_user_remove_parser(root: SubParserAction) -> argparse.ArgumentParser:
                              formatter_class=_formatter)
     parser.add_argument("username", help="username for web service")
     parser.add_argument("-s", "--secure", help="set file permissions to user-only", action="store_true")
-    parser.set_defaults(handler=handlers.Users, action=Action.Remove, architecture=[""], lock=None, no_report=True,  # nosec
+    parser.set_defaults(handler=handlers.User, action=Action.Remove, architecture=[""], lock=None, no_report=True,  # nosec
                         password="", quiet=True, unsafe=True)
     return parser
 

src/ahriman/application/application/application.py

@@ -19,34 +19,14 @@
 #
 from typing import Set
 
-from ahriman.application.application.application_packages import ApplicationPackages
-from ahriman.application.application.application_repository import ApplicationRepository
+from ahriman.application.application.packages import Packages
+from ahriman.application.application.repository import Repository
 from ahriman.models.result import Result
 
 
-class Application(ApplicationPackages, ApplicationRepository):
+class Application(Packages, Repository):
     """
     base application class
-
-    Examples:
-        This class groups ``Repository`` methods into specific method which process all supposed actions caused by
-        underlying action. E.g.::
-
-            >>> from ahriman.core.configuration import Configuration
-            >>> from ahriman.models.package_source import PackageSource
-            >>>
-            >>> configuration = Configuration()
-            >>> application = Application("x86_64", configuration, no_report=False, unsafe=False)
-            >>> # add packages to build queue
-            >>> application.add(["ahriman"], PackageSource.AUR, without_dependencies=False)
-            >>>
-            >>> # check for updates
-            >>> updates = application.updates([], no_aur=False, no_local=False, no_manual=False, no_vcs=False, log_fn=print)
-            >>> # updates for specified packages
-            >>> application.update(updates)
-
-        In case if specific actions or their order are required, the direct access to ``Repository`` must
-        be used instead.
     """
 
     def _finalize(self, result: Result) -> None:

src/ahriman/application/application/packages.py

@@ -23,7 +23,7 @@ import shutil
 from pathlib import Path
 from typing import Any, Iterable, Set
 
-from ahriman.application.application.application_properties import ApplicationProperties
+from ahriman.application.application.properties import Properties
 from ahriman.core.build_tools.sources import Sources
 from ahriman.core.util import package_like, tmpdir
 from ahriman.models.package import Package
@@ -31,7 +31,7 @@ from ahriman.models.package_source import PackageSource
 from ahriman.models.result import Result
 
 
-class ApplicationPackages(ApplicationProperties):
+class Packages(Properties):
     """
     package control class
     """
@@ -80,13 +80,12 @@ class ApplicationPackages(ApplicationProperties):
             known_packages(Set[str]): list of packages which are known by the service
             without_dependencies(bool): if set, dependency check will be disabled
         """
-        package = Package.from_aur(source, self.repository.pacman)
+        package = Package.load(source, PackageSource.AUR, self.repository.pacman, self.repository.aur_url)
 
         self.database.build_queue_insert(package)
-        self.database.remote_update(package)
 
         with tmpdir() as local_path:
-            Sources.load(local_path, package, self.database.patches_get(package.base), self.repository.paths)
+            Sources.load(local_path, package.git_url, self.database.patches_get(package.base))
             self._process_dependencies(local_path, known_packages, without_dependencies)
 
     def _add_directory(self, source: str, *_: Any) -> None:
@@ -109,10 +108,9 @@ class ApplicationPackages(ApplicationProperties):
             known_packages(Set[str]): list of packages which are known by the service
             without_dependencies(bool): if set, dependency check will be disabled
         """
-        source_dir = Path(source)
-        package = Package.from_build(source_dir)
+        package = Package.load(source, PackageSource.Local, self.repository.pacman, self.repository.aur_url)
         cache_dir = self.repository.paths.cache_for(package.base)
-        shutil.copytree(source_dir, cache_dir)  # copy package to store in caches
+        shutil.copytree(Path(source), cache_dir)  # copy package to store in caches
         Sources.init(cache_dir)  # we need to run init command in directory where we do have permissions
 
         self.database.build_queue_insert(package)
@@ -134,18 +132,6 @@ class ApplicationPackages(ApplicationProperties):
             for chunk in response.iter_content(chunk_size=1024):
                 local_file.write(chunk)
 
-    def _add_repository(self, source: str, *_: Any) -> None:
-        """
-        add package from official repository
-
-        Args:
-            source(str): package base name
-        """
-        package = Package.from_official(source, self.repository.pacman)
-        self.database.build_queue_insert(package)
-        self.database.remote_update(package)
-        # repository packages must not depend on unknown packages, thus we are not going to process dependencies
-
     def _process_dependencies(self, local_path: Path, known_packages: Set[str], without_dependencies: bool) -> None:
         """
         process package dependencies

src/ahriman/application/application/properties.py

@@ -20,11 +20,11 @@
 import logging
 
 from ahriman.core.configuration import Configuration
-from ahriman.core.database import SQLite
+from ahriman.core.database.sqlite import SQLite
 from ahriman.core.repository import Repository
 
 
-class ApplicationProperties:
+class Properties:
     """
     application base properties class
 

src/ahriman/application/application/repository.py

@@ -22,15 +22,15 @@ import shutil
 from pathlib import Path
 from typing import Callable, Iterable, List
 
-from ahriman.application.application.application_properties import ApplicationProperties
+from ahriman.application.application.properties import Properties
 from ahriman.core.build_tools.sources import Sources
-from ahriman.core.formatters import UpdatePrinter
+from ahriman.core.formatters.update_printer import UpdatePrinter
 from ahriman.core.tree import Tree
 from ahriman.models.package import Package
 from ahriman.models.result import Result
 
 
-class ApplicationRepository(ApplicationProperties):
+class Repository(Properties):
     """
     repository control class
     """
@@ -128,14 +128,14 @@ class ApplicationRepository(ApplicationProperties):
             packages: List[str] = []
             for single in probe.packages:
                 try:
-                    _ = Package.from_aur(single, self.repository.pacman)
+                    _ = Package.from_aur(single, probe.aur_url)
                 except Exception:
                     packages.append(single)
             return packages
 
         def unknown_local(probe: Package) -> List[str]:
             cache_dir = self.repository.paths.cache_for(probe.base)
-            local = Package.from_build(cache_dir)
+            local = Package.from_build(cache_dir, probe.aur_url)
             packages = set(probe.packages.keys()).difference(local.packages.keys())
             return list(packages)
 
@@ -169,7 +169,7 @@ class ApplicationRepository(ApplicationProperties):
         process_update(packages, build_result)
 
         # process manual packages
-        tree = Tree.load(updates, self.repository.paths, self.database)
+        tree = Tree.load(updates, self.database)
         for num, level in enumerate(tree.levels()):
             self.logger.info("processing level #%i %s", num, [package.base for package in level])
             build_result = self.repository.process_build(level)

src/ahriman/application/handlers/__init__.py

@@ -39,5 +39,5 @@ from ahriman.application.handlers.status_update import StatusUpdate
 from ahriman.application.handlers.sync import Sync
 from ahriman.application.handlers.unsafe_commands import UnsafeCommands
 from ahriman.application.handlers.update import Update
-from ahriman.application.handlers.users import Users
+from ahriman.application.handlers.user import User
 from ahriman.application.handlers.web import Web

src/ahriman/application/handlers/add.py

@@ -22,7 +22,7 @@ import argparse
 from typing import Type
 
 from ahriman.application.application import Application
-from ahriman.application.handlers import Handler
+from ahriman.application.handlers.handler import Handler
 from ahriman.core.configuration import Configuration
 
 

src/ahriman/application/handlers/backup.py

@@ -24,9 +24,9 @@ from pathlib import Path
 from tarfile import TarFile
 from typing import Set, Type
 
-from ahriman.application.handlers import Handler
+from ahriman.application.handlers.handler import Handler
 from ahriman.core.configuration import Configuration
-from ahriman.core.database import SQLite
+from ahriman.core.database.sqlite import SQLite
 
 
 class Backup(Handler):

src/ahriman/application/handlers/clean.py

@@ -22,7 +22,7 @@ import argparse
 from typing import Type
 
 from ahriman.application.application import Application
-from ahriman.application.handlers import Handler
+from ahriman.application.handlers.handler import Handler
 from ahriman.core.configuration import Configuration
 
 

src/ahriman/application/handlers/dump.py

@@ -21,9 +21,9 @@ import argparse
 
 from typing import Type
 
-from ahriman.application.handlers import Handler
+from ahriman.application.handlers.handler import Handler
 from ahriman.core.configuration import Configuration
-from ahriman.core.formatters import ConfigurationPrinter
+from ahriman.core.formatters.configuration_printer import ConfigurationPrinter
 
 
 class Dump(Handler):

src/ahriman/application/handlers/handler.py

@@ -38,13 +38,6 @@ class Handler:
     Attributes:
         ALLOW_AUTO_ARCHITECTURE_RUN(bool): (class attribute) allow defining architecture from existing repositories
         ALLOW_MULTI_ARCHITECTURE_RUN(bool): (class attribute) allow running with multiple architectures
-
-    Examples:
-        Wrapper for all command line actions, though each derived class implements ``run`` method, it usually must not
-        be called directly. The recommended way is to call ``execute`` class method, e.g.::
-
-            >>> from ahriman.application.handlers import Add
-            >>> Add.execute(args)
     """
 
     ALLOW_AUTO_ARCHITECTURE_RUN = True

src/ahriman/application/handlers/help.py

@@ -21,7 +21,7 @@ import argparse
 
 from typing import Type
 
-from ahriman.application.handlers import Handler
+from ahriman.application.handlers.handler import Handler
 from ahriman.core.configuration import Configuration
 
 

src/ahriman/application/handlers/key_import.py

@@ -22,7 +22,7 @@ import argparse
 from typing import Type
 
 from ahriman.application.application import Application
-from ahriman.application.handlers import Handler
+from ahriman.application.handlers.handler import Handler
 from ahriman.core.configuration import Configuration
 
 

src/ahriman/application/handlers/patch.py

@@ -23,12 +23,13 @@ from pathlib import Path
 from typing import List, Optional, Type
 
 from ahriman.application.application import Application
-from ahriman.application.handlers import Handler
+from ahriman.application.handlers.handler import Handler
 from ahriman.core.build_tools.sources import Sources
 from ahriman.core.configuration import Configuration
-from ahriman.core.formatters import StringPrinter
+from ahriman.core.formatters.string_printer import StringPrinter
 from ahriman.models.action import Action
 from ahriman.models.package import Package
+from ahriman.models.package_source import PackageSource
 
 
 class Patch(Handler):
@@ -56,20 +57,21 @@ class Patch(Handler):
         elif args.action == Action.Remove:
             Patch.patch_set_remove(application, args.package)
         elif args.action == Action.Update:
-            Patch.patch_set_create(application, Path(args.package), args.track)
+            Patch.patch_set_create(application, args.package, args.track)
 
     @staticmethod
-    def patch_set_create(application: Application, sources_dir: Path, track: List[str]) -> None:
+    def patch_set_create(application: Application, sources_dir: str, track: List[str]) -> None:
         """
         create patch set for the package base
 
         Args:
             application(Application): application instance
-            sources_dir(Path): path to directory with the package sources
+            sources_dir(str): path to directory with the package sources
             track(List[str]): track files which match the glob before creating the patch
         """
-        package = Package.from_build(sources_dir)
-        patch = Sources.patch_create(sources_dir, *track)
+        package = Package.load(sources_dir, PackageSource.Local, application.repository.pacman,
+                               application.repository.aur_url)
+        patch = Sources.patch_create(Path(sources_dir), *track)
         application.database.patches_insert(package.base, patch)
 
     @staticmethod

src/ahriman/application/handlers/rebuild.py

@@ -22,9 +22,9 @@ import argparse
 from typing import List, Type
 
 from ahriman.application.application import Application
-from ahriman.application.handlers import Handler
+from ahriman.application.handlers.handler import Handler
 from ahriman.core.configuration import Configuration
-from ahriman.core.formatters import UpdatePrinter
+from ahriman.core.formatters.update_printer import UpdatePrinter
 from ahriman.models.package import Package
 
 

src/ahriman/application/handlers/remove.py

@@ -22,7 +22,7 @@ import argparse
 from typing import Type
 
 from ahriman.application.application import Application
-from ahriman.application.handlers import Handler
+from ahriman.application.handlers.handler import Handler
 from ahriman.core.configuration import Configuration
 
 

src/ahriman/application/handlers/remove_unknown.py

@@ -22,9 +22,9 @@ import argparse
 from typing import Type
 
 from ahriman.application.application import Application
-from ahriman.application.handlers import Handler
+from ahriman.application.handlers.handler import Handler
 from ahriman.core.configuration import Configuration
-from ahriman.core.formatters import StringPrinter
+from ahriman.core.formatters.string_printer import StringPrinter
 
 
 class RemoveUnknown(Handler):

src/ahriman/application/handlers/report.py

@@ -22,7 +22,7 @@ import argparse
 from typing import Type
 
 from ahriman.application.application import Application
-from ahriman.application.handlers import Handler
+from ahriman.application.handlers.handler import Handler
 from ahriman.core.configuration import Configuration
 from ahriman.models.result import Result
 

src/ahriman/application/handlers/restore.py

@@ -22,7 +22,7 @@ import argparse
 from typing import Type
 from tarfile import TarFile
 
-from ahriman.application.handlers import Handler
+from ahriman.application.handlers.handler import Handler
 from ahriman.core.configuration import Configuration
 
 

src/ahriman/application/handlers/search.py

@@ -22,12 +22,12 @@ import argparse
 from dataclasses import fields
 from typing import Callable, Iterable, List, Tuple, Type
 
-from ahriman.application.application import Application
-from ahriman.application.handlers import Handler
-from ahriman.core.alpm.remote import AUR, Official
+from ahriman.application.handlers.handler import Handler
+from ahriman.core.alpm.remote.aur import AUR
+from ahriman.core.alpm.remote.official import Official
 from ahriman.core.configuration import Configuration
 from ahriman.core.exceptions import InvalidOption
-from ahriman.core.formatters import AurPrinter
+from ahriman.core.formatters.aur_printer import AurPrinter
 from ahriman.models.aur_package import AURPackage
 
 
@@ -55,10 +55,8 @@ class Search(Handler):
             no_report(bool): force disable reporting
             unsafe(bool): if set no user check will be performed before path creation
         """
-        application = Application(architecture, configuration, no_report, unsafe)
-
-        official_packages_list = Official.multisearch(*args.search, pacman=application.repository.pacman)
-        aur_packages_list = AUR.multisearch(*args.search, pacman=application.repository.pacman)
+        official_packages_list = Official.multisearch(*args.search)
+        aur_packages_list = AUR.multisearch(*args.search)
         Search.check_if_empty(args.exit_code, not official_packages_list and not aur_packages_list)
 
         for packages_list in (official_packages_list, aur_packages_list):

src/ahriman/application/handlers/setup.py

@@ -23,7 +23,7 @@ from pathlib import Path
 from typing import Type
 
 from ahriman.application.application import Application
-from ahriman.application.handlers import Handler
+from ahriman.application.handlers.handler import Handler
 from ahriman.core.configuration import Configuration
 from ahriman.models.repository_paths import RepositoryPaths
 
@@ -123,7 +123,7 @@ class Setup(Handler):
     def configuration_create_devtools(prefix: str, architecture: str, source: Path,
                                       no_multilib: bool, repository: str, paths: RepositoryPaths) -> None:
         """
-        create configuration for devtools based on ``source`` configuration
+        create configuration for devtools based on `source` configuration
 
         Args:
             prefix(str): command prefix in {prefix}-{architecture}-build

src/ahriman/application/handlers/sign.py

@@ -22,7 +22,7 @@ import argparse
 from typing import Type
 
 from ahriman.application.application import Application
-from ahriman.application.handlers import Handler
+from ahriman.application.handlers.handler import Handler
 from ahriman.core.configuration import Configuration
 
 

src/ahriman/application/handlers/status.py

@@ -22,9 +22,10 @@ import argparse
 from typing import Callable, Iterable, Tuple, Type
 
 from ahriman.application.application import Application
-from ahriman.application.handlers import Handler
+from ahriman.application.handlers.handler import Handler
 from ahriman.core.configuration import Configuration
-from ahriman.core.formatters import PackagePrinter, StatusPrinter
+from ahriman.core.formatters.package_printer import PackagePrinter
+from ahriman.core.formatters.status_printer import StatusPrinter
 from ahriman.models.build_status import BuildStatus
 from ahriman.models.package import Package
 

src/ahriman/application/handlers/status_update.py

@@ -22,7 +22,7 @@ import argparse
 from typing import Type
 
 from ahriman.application.application import Application
-from ahriman.application.handlers import Handler
+from ahriman.application.handlers.handler import Handler
 from ahriman.core.configuration import Configuration
 from ahriman.models.action import Action
 

src/ahriman/application/handlers/sync.py

@@ -22,7 +22,7 @@ import argparse
 from typing import Type
 
 from ahriman.application.application import Application
-from ahriman.application.handlers import Handler
+from ahriman.application.handlers.handler import Handler
 from ahriman.core.configuration import Configuration
 
 

src/ahriman/application/handlers/unsafe_commands.py

@@ -22,9 +22,9 @@ import shlex
 
 from typing import List, Type
 
-from ahriman.application.handlers import Handler
+from ahriman.application.handlers.handler import Handler
 from ahriman.core.configuration import Configuration
-from ahriman.core.formatters import StringPrinter
+from ahriman.core.formatters.string_printer import StringPrinter
 
 
 class UnsafeCommands(Handler):

src/ahriman/application/handlers/update.py

@@ -22,7 +22,7 @@ import argparse
 from typing import Callable, Type
 
 from ahriman.application.application import Application
-from ahriman.application.handlers import Handler
+from ahriman.application.handlers.handler import Handler
 from ahriman.core.configuration import Configuration
 
 

src/ahriman/application/handlers/user.py

@@ -23,15 +23,15 @@ import getpass
 from pathlib import Path
 from typing import Type
 
-from ahriman.application.handlers import Handler
+from ahriman.application.handlers.handler import Handler
 from ahriman.core.configuration import Configuration
-from ahriman.core.database import SQLite
-from ahriman.core.formatters import UserPrinter
+from ahriman.core.database.sqlite import SQLite
+from ahriman.core.formatters.user_printer import UserPrinter
 from ahriman.models.action import Action
-from ahriman.models.user import User
+from ahriman.models.user import User as MUser
 
 
-class Users(Handler):
+class User(Handler):
     """
     user management handler
     """
@@ -54,30 +54,30 @@ class Users(Handler):
         database = SQLite.load(configuration)
 
         if args.action == Action.Update:
-            salt = Users.get_salt(configuration)
-            user = Users.user_create(args)
+            salt = User.get_salt(configuration)
+            user = User.user_create(args)
 
-            auth_configuration = Users.configuration_get(configuration.include)
+            auth_configuration = User.configuration_get(configuration.include)
 
-            Users.configuration_create(auth_configuration, user, salt, args.as_service, args.secure)
+            User.configuration_create(auth_configuration, user, salt, args.as_service, args.secure)
             database.user_update(user.hash_password(salt))
         elif args.action == Action.List:
             users = database.user_list(args.username, args.role)
-            Users.check_if_empty(args.exit_code, not users)
+            User.check_if_empty(args.exit_code, not users)
             for user in users:
                 UserPrinter(user).print(verbose=True)
         elif args.action == Action.Remove:
             database.user_remove(args.username)
 
     @staticmethod
-    def configuration_create(configuration: Configuration, user: User, salt: str,
+    def configuration_create(configuration: Configuration, user: MUser, salt: str,
                              as_service_user: bool, secure: bool) -> None:
         """
         enable configuration if it has been disabled
 
         Args:
             configuration(Configuration): configuration instance
-            user(User): user descriptor
+            user(MUser): user descriptor
             salt(str): password hash salt
             as_service_user(bool): add user as service user, also set password and user to configuration
             secure(bool): if true then set file permissions to 0o600
@@ -86,7 +86,7 @@ class Users(Handler):
         if as_service_user:
             configuration.set_option("web", "username", user.username)
             configuration.set_option("web", "password", user.password)
-        Users.configuration_write(configuration, secure)
+        User.configuration_write(configuration, secure)
 
     @staticmethod
     def configuration_get(include_path: Path) -> Configuration:
@@ -136,10 +136,10 @@ class Users(Handler):
         """
         if salt := configuration.get("auth", "salt", fallback=None):
             return salt
-        return User.generate_password(salt_length)
+        return MUser.generate_password(salt_length)
 
     @staticmethod
-    def user_create(args: argparse.Namespace) -> User:
+    def user_create(args: argparse.Namespace) -> MUser:
         """
         create user descriptor from arguments
 
@@ -147,9 +147,9 @@ class Users(Handler):
             args(argparse.Namespace): command line args
 
         Returns:
-            User: built user descriptor
+            MUser: built user descriptor
         """
-        user = User(args.username, args.password, args.role)
+        user = MUser(args.username, args.password, args.role)
         if user.password is None:
             user.password = getpass.getpass()
         return user

src/ahriman/application/handlers/web.py

@@ -21,7 +21,7 @@ import argparse
 
 from typing import Type
 
-from ahriman.application.handlers import Handler
+from ahriman.application.handlers.handler import Handler
 from ahriman.core.configuration import Configuration
 from ahriman.core.spawn import Spawn
 

src/ahriman/application/lock.py

@@ -44,19 +44,6 @@ class Lock:
         reporter(Client): build status reporter instance
         paths(RepositoryPaths): repository paths instance
         unsafe(bool): skip user check
-
-    Examples:
-        Instance of this class except for controlling file-based lock is also required for basic applications checks.
-        The common flow is to create instance in ``with`` block and handle exceptions after all::
-
-            >>> from ahriman.core.configuration import Configuration
-            >>>
-            >>> configuration = Configuration()
-            >>> try:
-            >>>     with Lock(args, "x86_64", configuration):
-            >>>         perform_actions()
-            >>> except Exception as exception:
-            >>>     handle_exceptions(exception)
     """
 
     def __init__(self, args: argparse.Namespace, architecture: str, configuration: Configuration) -> None:

src/ahriman/core/alpm/pacman.py

@@ -17,8 +17,8 @@
 # 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 pyalpm import Handle, Package, SIG_PACKAGE  # type: ignore
-from typing import Generator, Set
+from pyalpm import Handle  # type: ignore
+from typing import Set
 
 from ahriman.core.configuration import Configuration
 
@@ -28,7 +28,7 @@ class Pacman:
     alpm wrapper
 
     Attributes:
-        handle(Handle): pyalpm root ``Handle``
+        handle(Handle): pyalpm root `Handle`
     """
 
     def __init__(self, configuration: Configuration) -> None:
@@ -42,7 +42,7 @@ class Pacman:
         pacman_root = configuration.getpath("alpm", "database")
         self.handle = Handle(root, str(pacman_root))
         for repository in configuration.getlist("alpm", "repositories"):
-            self.handle.register_syncdb(repository, SIG_PACKAGE)
+            self.handle.register_syncdb(repository, 0)  # 0 is pgp_level
 
     def all_packages(self) -> Set[str]:
         """
@@ -58,19 +58,3 @@ class Pacman:
                 result.update(package.provides)  # provides list for meta-packages
 
         return result
-
-    def get(self, package_name: str) -> Generator[Package, None, None]:
-        """
-        retrieve list of the packages from the repository by name
-
-        Args:
-            package_name(str): package name to search
-
-        Yields:
-            Package: list of packages which were returned by the query
-        """
-        for database in self.handle.get_syncdbs():
-            package = database.get_pkg(package_name)
-            if package is None:
-                continue
-            yield package

src/ahriman/core/alpm/remote/__init__.py

@@ -17,8 +17,3 @@
 # 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 ahriman.core.alpm.remote.remote import Remote
-
-from ahriman.core.alpm.remote.aur import AUR
-from ahriman.core.alpm.remote.official import Official
-from ahriman.core.alpm.remote.official_syncdb import OfficialSyncdb

src/ahriman/core/alpm/remote/aur.py

@@ -19,10 +19,9 @@
 #
 import requests
 
-from typing import Any, Dict, List, Type
+from typing import Any, Dict, List, Optional
 
-from ahriman.core.alpm.pacman import Pacman
-from ahriman.core.alpm.remote import Remote
+from ahriman.core.alpm.remote.remote import Remote
 from ahriman.core.exceptions import InvalidPackageInfo
 from ahriman.core.util import exception_response_text
 from ahriman.models.aur_package import AURPackage
@@ -33,15 +32,27 @@ class AUR(Remote):
     AUR RPC wrapper
 
     Attributes:
-        DEFAULT_AUR_URL(str): (class attribute) default AUR url
         DEFAULT_RPC_URL(str): (class attribute) default AUR RPC url
         DEFAULT_RPC_VERSION(str): (class attribute) default AUR RPC version
+        rpc_url(str): AUR RPC url
+        rpc_version(str): AUR RPC version
     """
 
-    DEFAULT_AUR_URL = "https://aur.archlinux.org"
-    DEFAULT_RPC_URL = f"{DEFAULT_AUR_URL}/rpc"
+    DEFAULT_RPC_URL = "https://aur.archlinux.org/rpc"
     DEFAULT_RPC_VERSION = "5"
 
+    def __init__(self, rpc_url: Optional[str] = None, rpc_version: Optional[str] = None) -> None:
+        """
+        default constructor
+
+        Args:
+            rpc_url(Optional[str], optional): AUR RPC url (Default value = None)
+            rpc_version(Optional[str], optional): AUR RPC version (Default value = None)
+        """
+        Remote.__init__(self)
+        self.rpc_url = rpc_url or self.DEFAULT_RPC_URL
+        self.rpc_version = rpc_version or self.DEFAULT_RPC_VERSION
+
     @staticmethod
     def parse_response(response: Dict[str, Any]) -> List[AURPackage]:
         """
@@ -62,33 +73,6 @@ class AUR(Remote):
             raise InvalidPackageInfo(error_details)
         return [AURPackage.from_json(package) for package in response["results"]]
 
-    @classmethod
-    def remote_git_url(cls: Type[Remote], package_base: str, repository: str) -> str:
-        """
-        generate remote git url from the package base
-
-        Args
-            package_base(str): package base
-            repository(str): repository name
-
-        Returns:
-            str: git url for the specific base
-        """
-        return f"{AUR.DEFAULT_AUR_URL}/{package_base}.git"
-
-    @classmethod
-    def remote_web_url(cls: Type[Remote], package_base: str) -> str:
-        """
-        generate remote web url from the package base
-
-        Args
-            package_base(str): package base
-
-        Returns:
-            str: web url for the specific base
-        """
-        return f"{AUR.DEFAULT_AUR_URL}/packages/{package_base}"
-
     def make_request(self, request_type: str, *args: str, **kwargs: str) -> List[AURPackage]:
         """
         perform request to AUR RPC
@@ -103,7 +87,7 @@ class AUR(Remote):
         """
         query: Dict[str, Any] = {
             "type": request_type,
-            "v": self.DEFAULT_RPC_VERSION
+            "v": self.rpc_version
         }
 
         arg_query = "arg[]" if len(args) > 1 else "arg"
@@ -113,7 +97,7 @@ class AUR(Remote):
             query[key] = value
 
         try:
-            response = requests.get(self.DEFAULT_RPC_URL, params=query)
+            response = requests.get(self.rpc_url, params=query)
             response.raise_for_status()
             return self.parse_response(response.json())
         except requests.HTTPError as e:
@@ -126,13 +110,12 @@ class AUR(Remote):
             self.logger.exception("could not perform request by using type %s", request_type)
             raise
 
-    def package_info(self, package_name: str, *, pacman: Pacman) -> AURPackage:
+    def package_info(self, package_name: str) -> AURPackage:
         """
         get package info by its name
 
         Args:
             package_name(str): package name to search
-            pacman(Pacman): alpm wrapper instance
 
         Returns:
             AURPackage: package which match the package name
@@ -140,13 +123,12 @@ class AUR(Remote):
         packages = self.make_request("info", package_name)
         return next(package for package in packages if package.name == package_name)
 
-    def package_search(self, *keywords: str, pacman: Pacman) -> List[AURPackage]:
+    def package_search(self, *keywords: str) -> List[AURPackage]:
         """
         search package in AUR web
 
         Args:
             *keywords(str): keywords to search
-            pacman(Pacman): alpm wrapper instance
 
         Returns:
             List[AURPackage]: list of packages which match the criteria

src/ahriman/core/alpm/remote/official.py

@@ -19,10 +19,9 @@
 #
 import requests
 
-from typing import Any, Dict, List, Type
+from typing import Any, Dict, List, Optional
 
-from ahriman.core.alpm.pacman import Pacman
-from ahriman.core.alpm.remote import Remote
+from ahriman.core.alpm.remote.remote import Remote
 from ahriman.core.exceptions import InvalidPackageInfo
 from ahriman.core.util import exception_response_text
 from ahriman.models.aur_package import AURPackage
@@ -33,15 +32,22 @@ class Official(Remote):
     official repository RPC wrapper
 
     Attributes:
-        DEFAULT_ARCHLINUX_URL(str): (class attribute) default archlinux url
-        DEFAULT_SEARCH_REPOSITORIES(List[str]): (class attribute) default list of repositories to search
-        DEFAULT_RPC_URL(str): (class attribute) default archlinux repositories RPC url
+        DEFAULT_RPC_URL(str): (class attribute) default AUR RPC url
+        rpc_url(str): AUR RPC url
     """
 
-    DEFAULT_ARCHLINUX_URL = "https://archlinux.org"
-    DEFAULT_SEARCH_REPOSITORIES = ["Core", "Extra", "Multilib", "Community"]
     DEFAULT_RPC_URL = "https://archlinux.org/packages/search/json"
 
+    def __init__(self, rpc_url: Optional[str] = None) -> None:
+        """
+        default constructor
+
+        Args:
+            rpc_url(Optional[str], optional): AUR RPC url (Default value = None)
+        """
+        Remote.__init__(self)
+        self.rpc_url = rpc_url or self.DEFAULT_RPC_URL
+
     @staticmethod
     def parse_response(response: Dict[str, Any]) -> List[AURPackage]:
         """
@@ -60,35 +66,6 @@ class Official(Remote):
             raise InvalidPackageInfo("API validation error")
         return [AURPackage.from_repo(package) for package in response["results"]]
 
-    @classmethod
-    def remote_git_url(cls: Type[Remote], package_base: str, repository: str) -> str:
-        """
-        generate remote git url from the package base
-
-        Args
-            package_base(str): package base
-            repository(str): repository name
-
-        Returns:
-            str: git url for the specific base
-        """
-        if repository.lower() in ("core", "extra", "testing", "kde-unstable"):
-            return "https://github.com/archlinux/svntogit-packages.git"  # hardcoded, ok
-        return "https://github.com/archlinux/svntogit-community.git"
-
-    @classmethod
-    def remote_web_url(cls: Type[Remote], package_base: str) -> str:
-        """
-        generate remote web url from the package base
-
-        Args
-            package_base(str): package base
-
-        Returns:
-            str: web url for the specific base
-        """
-        return f"{Official.DEFAULT_ARCHLINUX_URL}/packages/{package_base}"
-
     def make_request(self, *args: str, by: str) -> List[AURPackage]:
         """
         perform request to official repositories RPC
@@ -101,7 +78,7 @@ class Official(Remote):
             List[AURPackage]: response parsed to package list
         """
         try:
-            response = requests.get(self.DEFAULT_RPC_URL, params={by: args, "repo": self.DEFAULT_SEARCH_REPOSITORIES})
+            response = requests.get(self.rpc_url, params={by: args})
             response.raise_for_status()
             return self.parse_response(response.json())
         except requests.HTTPError as e:
@@ -111,13 +88,12 @@ class Official(Remote):
             self.logger.exception("could not perform request")
             raise
 
-    def package_info(self, package_name: str, *, pacman: Pacman) -> AURPackage:
+    def package_info(self, package_name: str) -> AURPackage:
         """
         get package info by its name
 
         Args:
             package_name(str): package name to search
-            pacman(Pacman): alpm wrapper instance
 
         Returns:
             AURPackage: package which match the package name
@@ -125,13 +101,12 @@ class Official(Remote):
         packages = self.make_request(package_name, by="name")
         return next(package for package in packages if package.name == package_name)
 
-    def package_search(self, *keywords: str, pacman: Pacman) -> List[AURPackage]:
+    def package_search(self, *keywords: str) -> List[AURPackage]:
         """
         search package in AUR web
 
         Args:
             *keywords(str): keywords to search
-            pacman(Pacman): alpm wrapper instance
 
         Returns:
             List[AURPackage]: list of packages which match the criteria

src/ahriman/core/alpm/remote/official_syncdb.py

@@ -1,51 +0,0 @@
-#
-# Copyright (c) 2021-2022 ahriman team.
-#
-# 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 ahriman.core.alpm.pacman import Pacman
-from ahriman.core.alpm.remote import Official
-from ahriman.models.aur_package import AURPackage
-
-
-class OfficialSyncdb(Official):
-    """
-    official repository wrapper based on synchronized databases.
-
-    Despite the fact that official repository provides an API for the interaction according to the comment in issue
-    https://github.com/arcan1s/ahriman/pull/59#issuecomment-1106412297 we might face rate limits while requesting
-    updates.
-
-    This approach also has limitations, because we don't require superuser rights (neither going to download database
-    separately), the database file might be outdated and must be handled manually (or kind of). This behaviour might be
-    changed in the future.
-
-    Still we leave search function based on the official repositories RPC.
-    """
-
-    def package_info(self, package_name: str, *, pacman: Pacman) -> AURPackage:
-        """
-        get package info by its name
-
-        Args:
-            package_name(str): package name to search
-            pacman(Pacman): alpm wrapper instance
-
-        Returns:
-            AURPackage: package which match the package name
-        """
-        return next(AURPackage.from_pacman(package) for package in pacman.get(package_name))

src/ahriman/core/alpm/remote/remote.py

@@ -23,7 +23,6 @@ import logging
 
 from typing import Dict, List, Type
 
-from ahriman.core.alpm.pacman import Pacman
 from ahriman.models.aur_package import AURPackage
 
 
@@ -33,18 +32,6 @@ class Remote:
 
     Attributes:
         logger(logging.Logger): class logger
-
-    Examples:
-        These classes are designed to be used without instancing. In order to achieve it several class methods are
-        provided: ``info``, ``multisearch`` and ``search``. Thus, the basic flow is the following::
-
-            >>> from ahriman.core.alpm.remote import AUR, Official
-            >>>
-            >>> package = AUR.info("ahriman", pacman=pacman)
-            >>> search_result = Official.multisearch("pacman", "manager", pacman=pacman)
-
-        Differnece between ``search`` and ``multisearch`` is that ``search`` passes all arguments to underlying wrapper
-        directly, whereas ``multisearch`` splits search one by one and finds intersection between search results.
     """
 
     def __init__(self) -> None:
@@ -54,28 +41,26 @@ class Remote:
         self.logger = logging.getLogger("build_details")
 
     @classmethod
-    def info(cls: Type[Remote], package_name: str, *, pacman: Pacman) -> AURPackage:
+    def info(cls: Type[Remote], package_name: str) -> AURPackage:
         """
         get package info by its name
 
         Args:
             package_name(str): package name to search
-            pacman(Pacman): alpm wrapper instance
 
         Returns:
             AURPackage: package which match the package name
         """
-        return cls().package_info(package_name, pacman=pacman)
+        return cls().package_info(package_name)
 
     @classmethod
-    def multisearch(cls: Type[Remote], *keywords: str, pacman: Pacman) -> List[AURPackage]:
+    def multisearch(cls: Type[Remote], *keywords: str) -> List[AURPackage]:
         """
         search in remote repository by using API with multiple words. This method is required in order to handle
         https://bugs.archlinux.org/task/49133. In addition, short words will be dropped
 
         Args:
             *keywords(str): search terms, e.g. "ahriman", "is", "cool"
-            pacman(Pacman): alpm wrapper instance
 
         Returns:
             List[AURPackage]: list of packages each of them matches all search terms
@@ -83,7 +68,7 @@ class Remote:
         instance = cls()
         packages: Dict[str, AURPackage] = {}
         for term in filter(lambda word: len(word) > 3, keywords):
-            portion = instance.search(term, pacman=pacman)
+            portion = instance.search(term)
             packages = {
                 package.name: package  # not mistake to group them by name
                 for package in portion
@@ -92,59 +77,24 @@ class Remote:
         return list(packages.values())
 
     @classmethod
-    def remote_git_url(cls: Type[Remote], package_base: str, repository: str) -> str:
-        """
-        generate remote git url from the package base
-
-        Args
-            package_base(str): package base
-            repository(str): repository name
-
-        Returns:
-            str: git url for the specific base
-
-        Raises:
-            NotImplementedError: not implemented method
-        """
-        raise NotImplementedError
-
-    @classmethod
-    def remote_web_url(cls: Type[Remote], package_base: str) -> str:
-        """
-        generate remote web url from the package base
-
-        Args
-            package_base(str): package base
-
-        Returns:
-            str: web url for the specific base
-
-        Raises:
-            NotImplementedError: not implemented method
-        """
-        raise NotImplementedError
-
-    @classmethod
-    def search(cls: Type[Remote], *keywords: str, pacman: Pacman) -> List[AURPackage]:
+    def search(cls: Type[Remote], *keywords: str) -> List[AURPackage]:
         """
         search package in AUR web
 
         Args:
             *keywords(str): search terms, e.g. "ahriman", "is", "cool"
-            pacman(Pacman): alpm wrapper instance
 
         Returns:
             List[AURPackage]: list of packages which match the criteria
         """
-        return cls().package_search(*keywords, pacman=pacman)
+        return cls().package_search(*keywords)
 
-    def package_info(self, package_name: str, *, pacman: Pacman) -> AURPackage:
+    def package_info(self, package_name: str) -> AURPackage:
         """
         get package info by its name
 
         Args:
             package_name(str): package name to search
-            pacman(Pacman): alpm wrapper instance
 
         Returns:
             AURPackage: package which match the package name
@@ -154,13 +104,12 @@ class Remote:
         """
         raise NotImplementedError
 
-    def package_search(self, *keywords: str, pacman: Pacman) -> List[AURPackage]:
+    def package_search(self, *keywords: str) -> List[AURPackage]:
         """
         search package in AUR web
 
         Args:
             *keywords(str): keywords to search
-            pacman(Pacman): alpm wrapper instance
 
         Returns:
             List[AURPackage]: list of packages which match the criteria

src/ahriman/core/alpm/repo.py

@@ -59,8 +59,6 @@ class Repo:
     @property
     def repo_path(self) -> Path:
         """
-        get full path to the repository database
-
         Returns:
             Path: path to repository database
         """

src/ahriman/core/auth/__init__.py

@@ -17,7 +17,3 @@
 # 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 ahriman.core.auth.auth import Auth
-
-from ahriman.core.auth.mapping import Mapping
-from ahriman.core.auth.oauth import OAuth

src/ahriman/core/auth/auth.py

@@ -24,7 +24,7 @@ import logging
 from typing import Optional, Type
 
 from ahriman.core.configuration import Configuration
-from ahriman.core.database import SQLite
+from ahriman.core.database.sqlite import SQLite
 from ahriman.models.auth_settings import AuthSettings
 from ahriman.models.user_access import UserAccess
 
@@ -82,10 +82,10 @@ class Auth:
         """
         provider = AuthSettings.from_option(configuration.get("auth", "target", fallback="disabled"))
         if provider == AuthSettings.Configuration:
-            from ahriman.core.auth import Mapping
+            from ahriman.core.auth.mapping import Mapping
             return Mapping(configuration, database)
         if provider == AuthSettings.OAuth:
-            from ahriman.core.auth import OAuth
+            from ahriman.core.auth.oauth import OAuth
             return OAuth(configuration, database)
         return cls(configuration)
 

src/ahriman/core/auth/helpers.py

@@ -26,9 +26,6 @@ except ImportError:
     _has_aiohttp_security = False
 
 
-__all__ = ["authorized_userid", "check_authorized", "forget", "remember"]
-
-
 async def authorized_userid(*args: Any) -> Any:
     """
     handle aiohttp security methods

src/ahriman/core/auth/mapping.py

@@ -19,9 +19,10 @@
 #
 from typing import Optional
 
-from ahriman.core.auth import Auth
+from ahriman.core.auth.auth import Auth
+
 from ahriman.core.configuration import Configuration
-from ahriman.core.database import SQLite
+from ahriman.core.database.sqlite import SQLite
 from ahriman.models.auth_settings import AuthSettings
 from ahriman.models.user import User
 from ahriman.models.user_access import UserAccess

src/ahriman/core/auth/oauth.py

@@ -21,9 +21,9 @@ import aioauth_client
 
 from typing import Optional, Type
 
-from ahriman.core.auth import Mapping
+from ahriman.core.auth.mapping import Mapping
 from ahriman.core.configuration import Configuration
-from ahriman.core.database import SQLite
+from ahriman.core.database.sqlite import SQLite
 from ahriman.core.exceptions import InvalidOption
 from ahriman.models.auth_settings import AuthSettings
 
@@ -64,8 +64,6 @@ class OAuth(Mapping):
     @property
     def auth_control(self) -> str:
         """
-        get authorization html control
-
         Returns:
             str: login control as html code to insert
         """

src/ahriman/core/build_tools/sources.py

@@ -18,15 +18,11 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
 import logging
-import shutil
 
 from pathlib import Path
 from typing import List, Optional
 
-from ahriman.core.util import check_output, walk
-from ahriman.models.package import Package
-from ahriman.models.remote_source import RemoteSource
-from ahriman.models.repository_paths import RepositoryPaths
+from ahriman.core.util import check_output
 
 
 class Sources:
@@ -34,18 +30,16 @@ class Sources:
     helper to download package sources (PKGBUILD etc)
 
     Attributes:
-        DEFAULT_BRANCH(str): (class attribute) default branch to process git repositories.
-            Must be used only for local stored repositories, use RemoteSource descriptor instead for real packages
         logger(logging.Logger): (class attribute) class logger
     """
 
-    DEFAULT_BRANCH = "master"  # default fallback branch
     logger = logging.getLogger("build_details")
 
+    _branch = "master"  # in case if BLM would like to change it
     _check_output = check_output
 
     @staticmethod
-    def _add(sources_dir: Path, *pattern: str) -> None:
+    def add(sources_dir: Path, *pattern: str) -> None:
         """
         track found files via git
 
@@ -66,7 +60,7 @@ class Sources:
                               exception=None, cwd=sources_dir, logger=Sources.logger)
 
     @staticmethod
-    def _diff(sources_dir: Path) -> str:
+    def diff(sources_dir: Path) -> str:
         """
         generate diff from the current version and write it to the output file
 
@@ -79,28 +73,13 @@ class Sources:
         return Sources._check_output("git", "diff", exception=None, cwd=sources_dir, logger=Sources.logger)
 
     @staticmethod
-    def _move(pkgbuild_dir: Path, sources_dir: Path) -> None:
+    def fetch(sources_dir: Path, remote: Optional[str]) -> None:
         """
-        move content from pkgbuild_dir to sources_dir
-
-        Args:
-            pkgbuild_dir(Path): path to directory with pkgbuild from which need to move
-            sources_dir(Path): path to target directory
-        """
-        if pkgbuild_dir == sources_dir:
-            return  # directories are the same, no need to move
-        for src in walk(pkgbuild_dir):
-            dst = sources_dir / src.relative_to(pkgbuild_dir)
-            shutil.move(src, dst)
-
-    @staticmethod
-    def fetch(sources_dir: Path, remote: Optional[RemoteSource]) -> None:
-        """
-        either clone repository or update it to origin/``remote.branch``
+        either clone repository or update it to origin/`branch`
 
         Args:
             sources_dir(Path): local path to fetch
-            remote(Optional[RemoteSource]): remote target (from where to fetch)
+            remote(Optional[str]): remote target (from where to fetch)
         """
         # local directory exists and there is .git directory
         is_initialized_git = (sources_dir / ".git").is_dir()
@@ -109,31 +88,22 @@ class Sources:
             Sources.logger.info("skip update at %s because there are no branches configured", sources_dir)
             return
 
-        branch = remote.branch if remote is not None else Sources.DEFAULT_BRANCH
         if is_initialized_git:
-            Sources.logger.info("update HEAD to remote at %s using branch %s", sources_dir, branch)
-            Sources._check_output("git", "fetch", "origin", branch,
-                                  exception=None, cwd=sources_dir, logger=Sources.logger)
-        elif remote is not None:
-            Sources.logger.info("clone remote %s to %s using branch %s", remote.git_url, sources_dir, branch)
-            Sources._check_output("git", "clone", "--branch", branch, "--single-branch",
-                                  remote.git_url, str(sources_dir),
+            Sources.logger.info("update HEAD to remote at %s", sources_dir)
+            Sources._check_output("git", "fetch", "origin", Sources._branch,
                                   exception=None, cwd=sources_dir, logger=Sources.logger)
+        elif remote is None:
+            Sources.logger.warning("%s is not initialized, but no remote provided", sources_dir)
         else:
-            # it will cause an exception later
-            Sources.logger.error("%s is not initialized, but no remote provided", sources_dir)
-
+            Sources.logger.info("clone remote %s to %s", remote, sources_dir)
+            Sources._check_output("git", "clone", remote, str(sources_dir),
+                                  exception=None, cwd=sources_dir, logger=Sources.logger)
         # and now force reset to our branch
-        Sources._check_output("git", "checkout", "--force", branch,
+        Sources._check_output("git", "checkout", "--force", Sources._branch,
                               exception=None, cwd=sources_dir, logger=Sources.logger)
-        Sources._check_output("git", "reset", "--hard", f"origin/{branch}",
+        Sources._check_output("git", "reset", "--hard", f"origin/{Sources._branch}",
                               exception=None, cwd=sources_dir, logger=Sources.logger)
 
-        # move content if required
-        # we are using full path to source directory in order to make append possible
-        pkgbuild_dir = remote.pkgbuild_dir if remote is not None else sources_dir.resolve()
-        Sources._move((sources_dir / pkgbuild_dir).resolve(), sources_dir)
-
     @staticmethod
     def has_remotes(sources_dir: Path) -> bool:
         """
@@ -156,25 +126,20 @@ class Sources:
         Args:
             sources_dir(Path): local path to sources
         """
-        Sources._check_output("git", "init", "--initial-branch", Sources.DEFAULT_BRANCH,
+        Sources._check_output("git", "init", "--initial-branch", Sources._branch,
                               exception=None, cwd=sources_dir, logger=Sources.logger)
 
     @staticmethod
-    def load(sources_dir: Path, package: Package, patch: Optional[str], paths: RepositoryPaths) -> None:
+    def load(sources_dir: Path, remote: str, patch: Optional[str]) -> None:
         """
         fetch sources from remote and apply patches
 
         Args:
             sources_dir(Path): local path to fetch
-            package(Package): package definitions
+            remote(str): remote target (from where to fetch)
             patch(Optional[str]): optional patch to be applied
-            paths(RepositoryPaths): repository paths instance
         """
-        if (cache_dir := paths.cache_for(package.base)).is_dir() and cache_dir != sources_dir:
-            # no need to clone whole repository, just copy from cache first
-            shutil.copytree(cache_dir, sources_dir, dirs_exist_ok=True)
-        Sources.fetch(sources_dir, package.remote)
-
+        Sources.fetch(sources_dir, remote)
         if patch is None:
             Sources.logger.info("no patches found")
             return
@@ -206,6 +171,6 @@ class Sources:
         Returns:
             str: patch as plain text
         """
-        Sources._add(sources_dir, *pattern)
-        diff = Sources._diff(sources_dir)
+        Sources.add(sources_dir, *pattern)
+        diff = Sources.diff(sources_dir)
         return f"{diff}\n"  # otherwise, patch will be broken

src/ahriman/core/build_tools/task.py

@@ -18,13 +18,14 @@
 # along with this program. If not, see <http://www.gnu.org/licenses/>.
 #
 import logging
+import shutil
 
 from pathlib import Path
 from typing import List
 
 from ahriman.core.build_tools.sources import Sources
 from ahriman.core.configuration import Configuration
-from ahriman.core.database import SQLite
+from ahriman.core.database.sqlite import SQLite
 from ahriman.core.exceptions import BuildFailed
 from ahriman.core.util import check_output
 from ahriman.models.package import Package
@@ -65,12 +66,12 @@ class Task:
         self.makepkg_flags = configuration.getlist("build", "makepkg_flags", fallback=[])
         self.makechrootpkg_flags = configuration.getlist("build", "makechrootpkg_flags", fallback=[])
 
-    def build(self, sources_dir: Path) -> List[Path]:
+    def build(self, sources_path: Path) -> List[Path]:
         """
         run package build
 
         Args:
-            sources_dir(Path): path to where sources are
+            sources_path(Path): path to where sources are
 
         Returns:
             List[Path]: paths of produced packages
@@ -84,23 +85,26 @@ class Task:
         Task._check_output(
             *command,
             exception=BuildFailed(self.package.base),
-            cwd=sources_dir,
+            cwd=sources_path,
             logger=self.build_logger,
             user=self.uid)
 
         # well it is not actually correct, but we can deal with it
         packages = Task._check_output("makepkg", "--packagelist",
                                       exception=BuildFailed(self.package.base),
-                                      cwd=sources_dir,
+                                      cwd=sources_path,
                                       logger=self.build_logger).splitlines()
         return [Path(package) for package in packages]
 
-    def init(self, sources_dir: Path, database: SQLite) -> None:
+    def init(self, path: Path, database: SQLite) -> None:
         """
         fetch package from git
 
         Args:
-            sources_dir(Path): local path to fetch
+            path(Path): local path to fetch
             database(SQLite): database instance
         """
-        Sources.load(sources_dir, self.package, database.patches_get(self.package.base), self.paths)
+        if self.paths.cache_for(self.package.base).is_dir():
+            # no need to clone whole repository, just copy from cache first
+            shutil.copytree(self.paths.cache_for(self.package.base), path, dirs_exist_ok=True)
+        Sources.load(path, self.package.git_url, database.patches_get(self.package.base))

src/ahriman/core/configuration.py

@@ -43,25 +43,6 @@ class Configuration(configparser.RawConfigParser):
         SYSTEM_CONFIGURATION_PATH(Path): (class attribute) default system configuration path distributed by package
         architecture(Optional[str]): repository architecture
         path(Optional[Path]): path to root configuration file
-
-    Examples:
-        Configuration class provides additional method in order to handle application configuration. Since this class is
-        derived from built-in ``configparser.RawConfigParser`` class, the same flow is applicable here. Nevertheless,
-        it is recommended to use ``from_path`` class method which also calls initialization methods::
-
-            >>> from pathlib import Path
-            >>>
-            >>> configuration = Configuration.from_path(Path("/etc/ahriman.ini"), "x86_64", quiet=False)
-            >>> repository_name = configuration.get("repository", "name")
-            >>> makepkg_flags = configuration.getlist("build", "makepkg_flags")
-
-        The configuration instance loaded in this way will contain only sections which are defined for the specified
-        architecture according to the merge rules. Moreover, the architecture names will be removed from section names.
-
-        In order to get current settings, the ``check_loaded`` method can be used. This method will raise an
-        ``InitializeException`` in case if configuration was not yet loaded::
-
-            >>> path, architecture = configuration.check_loaded()
     """
 
     DEFAULT_LOG_FORMAT = "[%(levelname)s %(asctime)s] [%(filename)s:%(lineno)d %(funcName)s]: %(message)s"
@@ -84,8 +65,6 @@ class Configuration(configparser.RawConfigParser):
     @property
     def include(self) -> Path:
         """
-        get full path to include directory
-
         Returns:
             Path: path to directory with configuration includes
         """
@@ -94,8 +73,6 @@ class Configuration(configparser.RawConfigParser):
     @property
     def logging_path(self) -> Path:
         """
-        get full path to logging configuration
-
         Returns:
             Path: path to logging configuration
         """
@@ -104,8 +81,6 @@ class Configuration(configparser.RawConfigParser):
     @property
     def repository_paths(self) -> RepositoryPaths:
         """
-        construct RepositoryPaths instance based on the configuration
-
         Returns:
             RepositoryPaths: repository paths instance
         """
@@ -329,7 +304,7 @@ class Configuration(configparser.RawConfigParser):
 
     def set_option(self, section: str, option: str, value: Optional[str]) -> None:
         """
-        set option. Unlike default ``configparser.RawConfigParser.set`` it also creates section if it does not exist
+        set option. Unlike default `configparser.RawConfigParser.set` it also creates section if it does not exist
 
         Args:
             section(str): section name

src/ahriman/core/database/__init__.py

@@ -17,4 +17,3 @@
 # 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 ahriman.core.database.sqlite import SQLite

src/ahriman/core/database/data/__init__.py

@@ -20,14 +20,15 @@
 from sqlite3 import Connection
 
 from ahriman.core.configuration import Configuration
-from ahriman.core.database.data.package_remotes import migrate_package_remotes
 from ahriman.core.database.data.package_statuses import migrate_package_statuses
 from ahriman.core.database.data.patches import migrate_patches
 from ahriman.core.database.data.users import migrate_users_data
 from ahriman.models.migration_result import MigrationResult
+from ahriman.models.repository_paths import RepositoryPaths
 
 
-def migrate_data(result: MigrationResult, connection: Connection, configuration: Configuration) -> None:
+def migrate_data(result: MigrationResult, connection: Connection,
+                 configuration: Configuration, paths: RepositoryPaths) -> None:
     """
     perform data migration
 
@@ -35,13 +36,10 @@ def migrate_data(result: MigrationResult, connection: Connection, configuration:
         result(MigrationResult): result of the schema migration
         connection(Connection): database connection
         configuration(Configuration): configuration instance
+        paths(RepositoryPaths): repository paths instance
     """
     # initial data migration
-    repository_paths = configuration.repository_paths
-
     if result.old_version <= 0:
-        migrate_package_statuses(connection, repository_paths)
-        migrate_patches(connection, repository_paths)
+        migrate_package_statuses(connection, paths)
+        migrate_patches(connection, paths)
         migrate_users_data(connection, configuration)
-    if result.old_version <= 1:
-        migrate_package_remotes(connection, repository_paths)

src/ahriman/core/database/data/package_remotes.py

@@ -1,64 +0,0 @@
-#
-# Copyright (c) 2021-2022 ahriman team.
-#
-# 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 sqlite3 import Connection
-
-from ahriman.models.package_source import PackageSource
-from ahriman.models.remote_source import RemoteSource
-from ahriman.models.repository_paths import RepositoryPaths
-
-
-__all__ = ["migrate_package_remotes"]
-
-
-# pylint: disable=protected-access
-def migrate_package_remotes(connection: Connection, paths: RepositoryPaths) -> None:
-    """
-    perform migration for package remote sources
-
-    Args:
-        connection(Connection): database connection
-        paths(RepositoryPaths): repository paths instance
-    """
-    from ahriman.core.database.operations.package_operations import PackageOperations
-
-    def insert_remote(base: str, remote: RemoteSource) -> None:
-        connection.execute(
-            """
-            update package_bases set
-            branch = :branch, git_url = :git_url, path = :path,
-            web_url = :web_url, source = :source
-            where package_base = :package_base
-            """,
-            dict(
-                package_base=base,
-                branch=remote.branch, git_url=remote.git_url, path=remote.path,
-                web_url=remote.web_url, source=remote.source
-            )
-        )
-
-    packages = PackageOperations._packages_get_select_package_bases(connection)
-    for package_base, package in packages.items():
-        local_cache = paths.cache_for(package_base)
-        if local_cache.exists() and not package.is_vcs:
-            continue  # skip packages which are not VCS and with local cache
-        remote_source = RemoteSource.from_source(PackageSource.AUR, package_base, "aur")
-        if remote_source is None:
-            continue  # should never happen
-        insert_remote(package_base, remote_source)

src/ahriman/core/database/data/package_statuses.py

@@ -26,9 +26,6 @@ from ahriman.models.package import Package
 from ahriman.models.repository_paths import RepositoryPaths
 
 
-__all__ = ["migrate_package_statuses"]
-
-
 def migrate_package_statuses(connection: Connection, paths: RepositoryPaths) -> None:
     """
     perform migration for package statuses
@@ -45,7 +42,7 @@ def migrate_package_statuses(connection: Connection, paths: RepositoryPaths) ->
             values
             (:package_base, :version, :aur_url)
             """,
-            dict(package_base=metadata.base, version=metadata.version, aur_url=""))
+            dict(package_base=metadata.base, version=metadata.version, aur_url=metadata.aur_url))
         connection.execute(
             """
             insert into package_statuses
@@ -80,3 +77,6 @@ def migrate_package_statuses(connection: Connection, paths: RepositoryPaths) ->
         status = BuildStatus.from_json(item["status"])
         insert_base(package, status)
         insert_packages(package)
+
+    connection.commit()
+    cache_path.unlink()

src/ahriman/core/database/data/patches.py

@@ -22,9 +22,6 @@ from sqlite3 import Connection
 from ahriman.models.repository_paths import RepositoryPaths
 
 
-__all__ = ["migrate_patches"]
-
-
 def migrate_patches(connection: Connection, paths: RepositoryPaths) -> None:
     """
     perform migration for patches
@@ -45,3 +42,5 @@ def migrate_patches(connection: Connection, paths: RepositoryPaths) -> None:
         connection.execute(
             """insert into patches (package_base, patch) values (:package_base, :patch)""",
             {"package_base": package.name, "patch": content})
+
+    connection.commit()