.gitignore

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

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,23 +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/source -type f -name "$(PROJECT)*.rst" -delete
-	rm -f docs/source/modules.rst
-	tox -e docs
-
-spec-html: spec
-	rm -rf docs/html
-	tox -e docs-html
-
 tests: clean
 	tox -e tests
 

README.rst

@@ -1,34 +0,0 @@
-
-ArcH Linux ReposItory MANager
-=============================
-
-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:
-
-  .. image:: web.png
-     :target: web.png
-     :alt: web interface
-
-Installation and run
---------------------
-
-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.md>`_.
-
-`FAQ <docs/faq.md>`_
-------------------------

docs/source/ahriman.application.application.rst

@@ -1,50 +0,0 @@
-ahriman.application.application package
-=======================================
-
-Submodules
-----------
-
-ahriman.application.application.application module
---------------------------------------------------
-
-.. automodule:: ahriman.application.application.application
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-ahriman.application.application.packages module
------------------------------------------------
-
-.. automodule:: ahriman.application.application.packages
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-ahriman.application.application.properties module
--------------------------------------------------
-
-.. automodule:: ahriman.application.application.properties
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-ahriman.application.application.repository module
--------------------------------------------------
-
-.. automodule:: ahriman.application.application.repository
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-Module contents
----------------
-
-.. automodule:: ahriman.application.application
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:

docs/source/ahriman.application.handlers.rst

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

docs/source/ahriman.application.rst

@@ -1,41 +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:
-   :private-members:
-
-ahriman.application.lock module
--------------------------------
-
-.. automodule:: ahriman.application.lock
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-Module contents
----------------
-
-.. automodule:: ahriman.application
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:

docs/source/ahriman.core.alpm.remote.rst

@@ -1,41 +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:
-   :private-members:
-
-ahriman.core.alpm.remote.official module
-----------------------------------------
-
-.. automodule:: ahriman.core.alpm.remote.official
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-ahriman.core.alpm.remote.remote module
---------------------------------------
-
-.. automodule:: ahriman.core.alpm.remote.remote
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-Module contents
----------------
-
-.. automodule:: ahriman.core.alpm.remote
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:

docs/source/ahriman.core.alpm.rst

@@ -1,40 +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:
-   :private-members:
-
-ahriman.core.alpm.repo module
------------------------------
-
-.. automodule:: ahriman.core.alpm.repo
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-Module contents
----------------
-
-.. automodule:: ahriman.core.alpm
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:

docs/source/ahriman.core.auth.rst

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

docs/source/ahriman.core.build_tools.rst

@@ -1,32 +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:
-   :private-members:
-
-ahriman.core.build\_tools.task module
--------------------------------------
-
-.. automodule:: ahriman.core.build_tools.task
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-Module contents
----------------
-
-.. automodule:: ahriman.core.build_tools
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:

docs/source/ahriman.core.database.data.rst

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

docs/source/ahriman.core.database.migrations.rst

@@ -1,23 +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:
-   :private-members:
-
-Module contents
----------------
-
-.. automodule:: ahriman.core.database.migrations
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:

docs/source/ahriman.core.database.operations.rst

@@ -1,59 +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:
-   :private-members:
-
-ahriman.core.database.operations.build\_operations module
----------------------------------------------------------
-
-.. automodule:: ahriman.core.database.operations.build_operations
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-ahriman.core.database.operations.operations module
---------------------------------------------------
-
-.. automodule:: ahriman.core.database.operations.operations
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-ahriman.core.database.operations.package\_operations module
------------------------------------------------------------
-
-.. automodule:: ahriman.core.database.operations.package_operations
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-ahriman.core.database.operations.patch\_operations module
----------------------------------------------------------
-
-.. automodule:: ahriman.core.database.operations.patch_operations
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-Module contents
----------------
-
-.. automodule:: ahriman.core.database.operations
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:

docs/source/ahriman.core.database.rst

@@ -1,33 +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:
-   :private-members:
-
-Module contents
----------------
-
-.. automodule:: ahriman.core.database
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:

docs/source/ahriman.core.formatters.rst

@@ -1,95 +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:
-   :private-members:
-
-ahriman.core.formatters.build\_printer module
----------------------------------------------
-
-.. automodule:: ahriman.core.formatters.build_printer
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-ahriman.core.formatters.configuration\_printer module
------------------------------------------------------
-
-.. automodule:: ahriman.core.formatters.configuration_printer
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-ahriman.core.formatters.package\_printer module
------------------------------------------------
-
-.. automodule:: ahriman.core.formatters.package_printer
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-ahriman.core.formatters.printer module
---------------------------------------
-
-.. automodule:: ahriman.core.formatters.printer
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-ahriman.core.formatters.status\_printer module
-----------------------------------------------
-
-.. automodule:: ahriman.core.formatters.status_printer
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-ahriman.core.formatters.string\_printer module
-----------------------------------------------
-
-.. automodule:: ahriman.core.formatters.string_printer
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-ahriman.core.formatters.update\_printer module
-----------------------------------------------
-
-.. automodule:: ahriman.core.formatters.update_printer
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-ahriman.core.formatters.user\_printer module
---------------------------------------------
-
-.. automodule:: ahriman.core.formatters.user_printer
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-Module contents
----------------
-
-.. automodule:: ahriman.core.formatters
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:

docs/source/ahriman.core.report.rst

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

docs/source/ahriman.core.repository.rst

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

docs/source/ahriman.core.rst

@@ -1,76 +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:
-   :private-members:
-
-ahriman.core.exceptions module
-------------------------------
-
-.. automodule:: ahriman.core.exceptions
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-ahriman.core.spawn module
--------------------------
-
-.. automodule:: ahriman.core.spawn
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-ahriman.core.tree module
-------------------------
-
-.. automodule:: ahriman.core.tree
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-ahriman.core.util module
-------------------------
-
-.. automodule:: ahriman.core.util
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-Module contents
----------------
-
-.. automodule:: ahriman.core
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:

docs/source/ahriman.core.sign.rst

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

docs/source/ahriman.core.status.rst

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

docs/source/ahriman.core.upload.rst

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

docs/source/ahriman.models.rst

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

docs/source/ahriman.rst

@@ -1,34 +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:
-   :private-members:
-
-Module contents
----------------
-
-.. automodule:: ahriman
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:

docs/source/ahriman.web.middlewares.rst

@@ -1,32 +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:
-   :private-members:
-
-ahriman.web.middlewares.exception\_handler module
--------------------------------------------------
-
-.. automodule:: ahriman.web.middlewares.exception_handler
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-Module contents
----------------
-
-.. automodule:: ahriman.web.middlewares
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:

docs/source/ahriman.web.rst

@@ -1,41 +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:
-   :private-members:
-
-ahriman.web.web module
-----------------------
-
-.. automodule:: ahriman.web.web
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-Module contents
----------------
-
-.. automodule:: ahriman.web
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:

docs/source/ahriman.web.views.rst

@@ -1,42 +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:
-   :private-members:
-
-ahriman.web.views.index module
-------------------------------
-
-.. automodule:: ahriman.web.views.index
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-Module contents
----------------
-
-.. automodule:: ahriman.web.views
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:

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

@@ -1,50 +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:
-   :private-members:
-
-ahriman.web.views.service.remove module
----------------------------------------
-
-.. automodule:: ahriman.web.views.service.remove
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-ahriman.web.views.service.request module
-----------------------------------------
-
-.. automodule:: ahriman.web.views.service.request
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-ahriman.web.views.service.search module
----------------------------------------
-
-.. automodule:: ahriman.web.views.service.search
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-Module contents
----------------
-
-.. automodule:: ahriman.web.views.service
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:

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

@@ -1,50 +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:
-   :private-members:
-
-ahriman.web.views.status.package module
----------------------------------------
-
-.. automodule:: ahriman.web.views.status.package
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-ahriman.web.views.status.packages module
-----------------------------------------
-
-.. automodule:: ahriman.web.views.status.packages
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-ahriman.web.views.status.status module
---------------------------------------
-
-.. automodule:: ahriman.web.views.status.status
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-Module contents
----------------
-
-.. automodule:: ahriman.web.views.status
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:

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

@@ -1,32 +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:
-   :private-members:
-
-ahriman.web.views.user.logout module
-------------------------------------
-
-.. automodule:: ahriman.web.views.user.logout
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:
-
-Module contents
----------------
-
-.. automodule:: ahriman.web.views.user
-   :members:
-   :no-undoc-members:
-   :show-inheritance:
-   :private-members:

docs/source/conf.py

@@ -1,73 +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
-# sys.path.insert(0, os.path.abspath("."))
-
-
-# -- Project information -----------------------------------------------------
-
-project = "ahriman"
-copyright = "2022, ahriman team"
-author = "ahriman team"
-
-# The full version, including alpha/beta/rc tags
-release = "2021-2022"
-
-
-# -- 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",
-]
-
-# 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 = "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"]
-
-
-# -- Extension configuration -------------------------------------------------
-
-autodoc_member_order = "groupwise"
-
-autodoc_default_options = {
-    "no-undoc-members": True,
-}

docs/source/index.rst

@@ -1,20 +0,0 @@
-.. ahriman documentation master file, created by
-   sphinx-quickstart on Sun Apr 17 18:05:36 2022.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to ahriman's documentation!
-===================================
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

docs/source/modules.rst

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

setup.py

@@ -93,12 +93,6 @@ setup(
             "mypy",
             "pylint",
         ],
-        "docs": [
-            "Sphinx",
-            "argparse-manpage",
-            "pydeps",
-            "sphinxcontrib-napoleon",
-        ],
         "s3": [
             "boto3",
         ],

src/ahriman/application/ahriman.py

@@ -43,12 +43,8 @@ SubParserAction = TypeVar("SubParserAction", bound="argparse._SubParsersAction[a
 def _formatter(prog: str) -> argparse.HelpFormatter:
     """
     formatter for the help message
-
+    :param prog: application name
-    Args:
+    :return: formatter used by default
-        prog(str): application name
-
-    Returns:
-        argparse.HelpFormatter: formatter used by default
     """
     return argparse.ArgumentDefaultsHelpFormatter(prog, width=120)
 
@@ -56,9 +52,7 @@ def _formatter(prog: str) -> argparse.HelpFormatter:
 def _parser() -> argparse.ArgumentParser:
     """
     command line parser generator
-
+    :return: command line parser for the application
-    Returns:
-        argparse.ArgumentParser: command line parser for the application
     """
     parser = argparse.ArgumentParser(prog="ahriman", description="ArcH Linux ReposItory MANager",
                                      epilog="Argument list can also be read from file by using @ prefix.",
@@ -113,12 +107,8 @@ def _parser() -> argparse.ArgumentParser:
 def _set_aur_search_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for AUR search subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("aur-search", aliases=["search"], help="search for package",
                              description="search for package in AUR using API", formatter_class=_formatter)
@@ -136,12 +126,8 @@ def _set_aur_search_parser(root: SubParserAction) -> argparse.ArgumentParser:
 def _set_help_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for listing help subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("help", help="show help message",
                              description="show help message for application or command and exit",
@@ -155,12 +141,8 @@ def _set_help_parser(root: SubParserAction) -> argparse.ArgumentParser:
 def _set_help_commands_unsafe_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for listing unsafe commands
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("help-commands-unsafe", help="list unsafe commands",
                              description="list unsafe commands as defined in default args", formatter_class=_formatter)
@@ -174,12 +156,8 @@ def _set_help_commands_unsafe_parser(root: SubParserAction) -> argparse.Argument
 def _set_key_import_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for key import subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("key-import", help="import PGP key",
                              description="import PGP key from public sources to the repository user",
@@ -197,12 +175,8 @@ def _set_key_import_parser(root: SubParserAction) -> argparse.ArgumentParser:
 def _set_package_add_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for package addition subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("package-add", aliases=["add", "package-update"], help="add package",
                              description="add existing or new package to the build queue",
@@ -230,12 +204,8 @@ def _set_package_add_parser(root: SubParserAction) -> argparse.ArgumentParser:
 def _set_package_remove_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for package removal subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("package-remove", aliases=["remove"], help="remove package",
                              description="remove package from the repository", formatter_class=_formatter)
@@ -247,12 +217,8 @@ def _set_package_remove_parser(root: SubParserAction) -> argparse.ArgumentParser
 def _set_package_status_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for package status subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("package-status", aliases=["status"], help="get package status",
                              description="request status of the package",
@@ -271,12 +237,8 @@ def _set_package_status_parser(root: SubParserAction) -> argparse.ArgumentParser
 def _set_package_status_remove_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for package status remove subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("package-status-remove", help="remove package status",
                              description="remove the package from the status page",
@@ -292,12 +254,8 @@ def _set_package_status_remove_parser(root: SubParserAction) -> argparse.Argumen
 def _set_package_status_update_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for package status update subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("package-status-update", aliases=["status-update"], help="update package status",
                              description="update package status on the status page", formatter_class=_formatter)
@@ -314,12 +272,8 @@ def _set_package_status_update_parser(root: SubParserAction) -> argparse.Argumen
 def _set_patch_add_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for new patch subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     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 "
@@ -338,12 +292,8 @@ def _set_patch_add_parser(root: SubParserAction) -> argparse.ArgumentParser:
 def _set_patch_list_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for list patches subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("patch-list", help="list patch sets",
                              description="list available patches for the package", formatter_class=_formatter)
@@ -356,12 +306,8 @@ def _set_patch_list_parser(root: SubParserAction) -> argparse.ArgumentParser:
 def _set_patch_remove_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for remove patches subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("patch-remove", help="remove patch set", description="remove patches for the package",
                              formatter_class=_formatter)
@@ -373,12 +319,8 @@ def _set_patch_remove_parser(root: SubParserAction) -> argparse.ArgumentParser:
 def _set_repo_backup_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for repository backup subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("repo-backup", help="backup repository data",
                              description="backup settings and database", formatter_class=_formatter)
@@ -390,12 +332,8 @@ def _set_repo_backup_parser(root: SubParserAction) -> argparse.ArgumentParser:
 def _set_repo_check_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for repository check subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("repo-check", aliases=["check"], help="check for updates",
                              description="check for packages updates. Same as update --dry-run --no-manual",
@@ -410,12 +348,8 @@ def _set_repo_check_parser(root: SubParserAction) -> argparse.ArgumentParser:
 def _set_repo_clean_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for repository clean subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("repo-clean", aliases=["clean"], help="clean local caches",
                              description="remove local caches",
@@ -434,12 +368,8 @@ def _set_repo_clean_parser(root: SubParserAction) -> argparse.ArgumentParser:
 def _set_repo_config_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for config subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("repo-config", aliases=["config"], help="dump configuration",
                              description="dump configuration for the specified architecture",
@@ -451,12 +381,8 @@ def _set_repo_config_parser(root: SubParserAction) -> argparse.ArgumentParser:
 def _set_repo_rebuild_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for repository rebuild subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("repo-rebuild", aliases=["rebuild"], help="rebuild repository",
                              description="force rebuild whole repository", formatter_class=_formatter)
@@ -477,12 +403,8 @@ def _set_repo_rebuild_parser(root: SubParserAction) -> argparse.ArgumentParser:
 def _set_repo_remove_unknown_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for remove unknown packages subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("repo-remove-unknown", aliases=["remove-unknown"], help="remove unknown packages",
                              description="remove packages which are missing in AUR and do not have local PKGBUILDs",
@@ -496,12 +418,8 @@ def _set_repo_remove_unknown_parser(root: SubParserAction) -> argparse.ArgumentP
 def _set_repo_report_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for report subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("repo-report", aliases=["report"], help="generate report",
                              description="generate repository report according to current settings",
@@ -515,12 +433,8 @@ def _set_repo_report_parser(root: SubParserAction) -> argparse.ArgumentParser:
 def _set_repo_restore_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for repository restore subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("repo-restore", help="restore repository data",
                              description="restore settings and database", formatter_class=_formatter)
@@ -533,12 +447,8 @@ def _set_repo_restore_parser(root: SubParserAction) -> argparse.ArgumentParser:
 def _set_repo_setup_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for setup subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("repo-setup", aliases=["init", "repo-init", "setup"], help="initial service configuration",
                              description="create initial service configuration, requires root",
@@ -562,12 +472,8 @@ def _set_repo_setup_parser(root: SubParserAction) -> argparse.ArgumentParser:
 def _set_repo_sign_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for sign subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("repo-sign", aliases=["sign"], help="sign packages",
                              description="(re-)sign packages and repository database according to current settings",
@@ -581,12 +487,8 @@ def _set_repo_sign_parser(root: SubParserAction) -> argparse.ArgumentParser:
 def _set_repo_status_update_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for repository status update subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("repo-status-update", help="update repository status",
                              description="update repository status on the status page", formatter_class=_formatter)
@@ -600,12 +502,8 @@ def _set_repo_status_update_parser(root: SubParserAction) -> argparse.ArgumentPa
 def _set_repo_sync_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for repository sync subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("repo-sync", aliases=["sync"], help="sync repository",
                              description="sync repository files to remote server according to current settings",
@@ -619,12 +517,8 @@ def _set_repo_sync_parser(root: SubParserAction) -> argparse.ArgumentParser:
 def _set_repo_update_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for repository update subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("repo-update", aliases=["update"], help="update packages",
                              description="check for packages updates and run build process if requested",
@@ -643,12 +537,8 @@ def _set_repo_update_parser(root: SubParserAction) -> argparse.ArgumentParser:
 def _set_user_add_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for create user subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("user-add", help="create or update user",
                              description="update user for web services with the given password and role. "
@@ -669,12 +559,8 @@ def _set_user_add_parser(root: SubParserAction) -> argparse.ArgumentParser:
 def _set_user_list_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for user list subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("user-list", help="user known users and their access",
                              description="list users from the user mapping and their roles",
@@ -690,12 +576,8 @@ def _set_user_list_parser(root: SubParserAction) -> argparse.ArgumentParser:
 def _set_user_remove_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for user removal subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("user-remove", help="remove user",
                              description="remove user from the user mapping and update the configuration",
@@ -710,12 +592,8 @@ def _set_user_remove_parser(root: SubParserAction) -> argparse.ArgumentParser:
 def _set_web_parser(root: SubParserAction) -> argparse.ArgumentParser:
     """
     add parser for web subcommand
-
+    :param root: subparsers for the commands
-    Args:
+    :return: created argument parser
-        root(SubParserAction): subparsers for the commands
-
-    Returns:
-        argparse.ArgumentParser: created argument parser
     """
     parser = root.add_parser("web", help="web server", description="start web server", formatter_class=_formatter)
     parser.set_defaults(handler=handlers.Web, lock=None, no_report=True, parser=_parser)

src/ahriman/application/application/application.py

@@ -32,9 +32,7 @@ class Application(Packages, Repository):
     def _finalize(self, result: Result) -> None:
         """
         generate report and sync to remote server
-
+        :param result: build result
-        Args:
-            result(Result): build result
         """
         self.report([], result)
         self.sync([], result.success)
@@ -42,9 +40,7 @@ class Application(Packages, Repository):
     def _known_packages(self) -> Set[str]:
         """
         load packages from repository and pacman repositories
-
+        :return: list of known packages
-        Returns:
-            Set[str]: list of known packages
         """
         known_packages: Set[str] = set()
         # local set

src/ahriman/application/application/packages.py

@@ -39,33 +39,21 @@ class Packages(Properties):
     def _finalize(self, result: Result) -> None:
         """
         generate report and sync to remote server
-
+        :param result: build result
-        Args:
-            result(Result): build result
-
-        Raises:
-            NotImplementedError: not implemented method
         """
         raise NotImplementedError
 
     def _known_packages(self) -> Set[str]:
         """
         load packages from repository and pacman repositories
-
+        :return: list of known packages
-        Returns:
-            Set[str]: list of known packages
-
-        Raises:
-            NotImplementedError: not implemented method
         """
         raise NotImplementedError
 
     def _add_archive(self, source: str, *_: Any) -> None:
         """
         add package from archive
-
+        :param source: path to package archive
-        Args:
-            source(str): path to package archive
         """
         local_path = Path(source)
         dst = self.repository.paths.packages / local_path.name
@@ -74,11 +62,9 @@ class Packages(Properties):
     def _add_aur(self, source: str, known_packages: Set[str], without_dependencies: bool) -> None:
         """
         add package from AUR
-
+        :param source: package base name
-        Args:
+        :param known_packages: list of packages which are known by the service
-            source(str): package base name
+        :param without_dependencies: if set, dependency check will be disabled
-            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.load(source, PackageSource.AUR, self.repository.pacman, self.repository.aur_url)
 
@@ -91,9 +77,7 @@ class Packages(Properties):
     def _add_directory(self, source: str, *_: Any) -> None:
         """
         add packages from directory
-
+        :param source: path to local directory
-        Args:
-            source(str): path to local directory
         """
         local_path = Path(source)
         for full_path in filter(package_like, local_path.iterdir()):
@@ -102,11 +86,9 @@ class Packages(Properties):
     def _add_local(self, source: str, known_packages: Set[str], without_dependencies: bool) -> None:
         """
         add package from local PKGBUILDs
-
+        :param source: path to directory with local source files
-        Args:
+        :param known_packages: list of packages which are known by the service
-            source(str): path to directory with local source files
+        :param without_dependencies: if set, dependency check will be disabled
-            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.load(source, PackageSource.Local, self.repository.pacman, self.repository.aur_url)
         cache_dir = self.repository.paths.cache_for(package.base)
@@ -120,9 +102,7 @@ class Packages(Properties):
     def _add_remote(self, source: str, *_: Any) -> None:
         """
         add package from remote sources (e.g. HTTP)
-
+        :param remote_url: remote URL to the package archive
-        Args:
-            source(str): remote URL of the package archive
         """
         dst = self.repository.paths.packages / Path(source).name  # URL is path, is not it?
         response = requests.get(source, stream=True)
@@ -135,11 +115,9 @@ class Packages(Properties):
     def _process_dependencies(self, local_path: Path, known_packages: Set[str], without_dependencies: bool) -> None:
         """
         process package dependencies
-
+        :param local_path: path to local package sources (i.e. cloned AUR repository)
-        Args:
+        :param known_packages: list of packages which are known by the service
-            local_path(Path): path to local package sources (i.e. cloned AUR repository)
+        :param without_dependencies: if set, dependency check will be disabled
-            known_packages(Set[str]): list of packages which are known by the service
-            without_dependencies(bool): if set, dependency check will be disabled
         """
         if without_dependencies:
             return
@@ -150,11 +128,9 @@ class Packages(Properties):
     def add(self, names: Iterable[str], source: PackageSource, without_dependencies: bool) -> None:
         """
         add packages for the next build
-
+        :param names: list of package bases to add
-        Args:
+        :param source: package source to add
-            names(Iterable[str]): list of package bases to add
+        :param without_dependencies: if set, dependency check will be disabled
-            source(PackageSource): package source to add
-            without_dependencies(bool): if set, dependency check will be disabled
         """
         known_packages = self._known_packages()  # speedup dependencies processing
 
@@ -166,9 +142,7 @@ class Packages(Properties):
     def remove(self, names: Iterable[str]) -> None:
         """
         remove packages from repository
-
+        :param names: list of packages (either base or name) to remove
-        Args:
-            names(Iterable[str]): list of packages (either base or name) to remove
         """
         self.repository.process_remove(names)
         self._finalize(Result())

src/ahriman/application/application/properties.py

@@ -27,24 +27,20 @@ from ahriman.core.repository import Repository
 class Properties:
     """
     application base properties class
-
+    :ivar architecture: repository architecture
-    Attributes:
+    :ivar configuration: configuration instance
-        architecture(str): repository architecture
+    :ivar database: database instance
-        configuration(Configuration): configuration instance
+    :ivar logger: application logger
-        database(SQLite): database instance
+    :ivar repository: repository instance
-        logger(logging.Logger): application logger
-        repository(Repository): repository instance
     """
 
     def __init__(self, architecture: str, configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         default constructor
-
+        :param architecture: repository architecture
-        Args:
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            no_report(bool): force disable reporting
-             unsafe(bool): if set no user check will be performed before path creation
         """
         self.logger = logging.getLogger("root")
         self.configuration = configuration

src/ahriman/application/application/repository.py

@@ -38,24 +38,17 @@ class Repository(Properties):
     def _finalize(self, result: Result) -> None:
         """
         generate report and sync to remote server
-
+        :param result: build result
-        Args:
-            result(Result): build result
-
-        Raises:
-            NotImplementedError: not implemented method
         """
         raise NotImplementedError
 
     def clean(self, cache: bool, chroot: bool, manual: bool, packages: bool) -> None:
         """
         run all clean methods. Warning: some functions might not be available under non-root
-
+        :param cache: clear directory with package caches
-        Args:
+        :param chroot: clear build chroot
-            cache(bool): clear directory with package caches
+        :param manual: clear directory with manually added packages
-            chroot(bool): clear build chroot
+        :param packages: clear directory with built packages
-            manual(bool): clear directory with manually added packages
-            packages(bool): clear directory with built packages
         """
         if cache:
             self.repository.clear_cache()
@@ -69,10 +62,8 @@ class Repository(Properties):
     def report(self, target: Iterable[str], result: Result) -> None:
         """
         generate report
-
+        :param target: list of targets to run (e.g. html)
-        Args:
+        :param result: build result
-            target(Iterable[str]): list of targets to run (e.g. html)
-            result(Result): build result
         """
         targets = target or None
         self.repository.process_report(targets, result)
@@ -80,9 +71,7 @@ class Repository(Properties):
     def sign(self, packages: Iterable[str]) -> None:
         """
         sign packages and repository
-
+        :param packages: only sign specified packages
-        Args:
-            packages(Iterable[str]): only sign specified packages
         """
         # copy to prebuilt directory
         for package in self.repository.packages():
@@ -105,10 +94,8 @@ class Repository(Properties):
     def sync(self, target: Iterable[str], built_packages: Iterable[Package]) -> None:
         """
         sync to remote server
-
+        :param target: list of targets to run (e.g. s3)
-        Args:
+        :param built_packages: list of packages which has just been built
-            target(Iterable[str]): list of targets to run (e.g. s3)
-            built_packages(Iterable[Package]): list of packages which has just been built
         """
         targets = target or None
         self.repository.process_sync(targets, built_packages)
@@ -116,9 +103,7 @@ class Repository(Properties):
     def unknown(self) -> List[str]:
         """
         get packages which were not found in AUR
-
+        :return: unknown package archive list
-        Returns:
-            List[str]: unknown package archive list
         """
         def has_local(probe: Package) -> bool:
             cache_dir = self.repository.paths.cache_for(probe.base)
@@ -150,12 +135,7 @@ class Repository(Properties):
     def update(self, updates: Iterable[Package]) -> Result:
         """
         run package updates
-
+        :param updates: list of packages to update
-        Args:
-            updates(Iterable[Package]): list of packages to update
-
-        Returns:
-            Result: update result
         """
         def process_update(paths: Iterable[Path], result: Result) -> None:
             if not paths:
@@ -182,17 +162,13 @@ class Repository(Properties):
                 log_fn: Callable[[str], None]) -> List[Package]:
         """
         get list of packages to run update process
-
+        :param filter_packages: do not check every package just specified in the list
-        Args:
+        :param no_aur: do not check for aur updates
-            filter_packages(Iterable[str]): do not check every package just specified in the list
+        :param no_local: do not check local packages for updates
-            no_aur(bool): do not check for aur updates
+        :param no_manual: do not check for manual updates
-            no_local(bool): do not check local packages for updates
+        :param no_vcs: do not check VCS packages
-            no_manual(bool): do not check for manual updates
+        :param log_fn: logger function to log updates
-            no_vcs(bool): do not check VCS packages
+        :return: list of out-of-dated packages
-            log_fn(Callable[[str], None]): logger function to log updates
-
-        Returns:
-            List[Package]: list of out-of-dated packages
         """
         updates = {}
 

src/ahriman/application/handlers/add.py

@@ -36,13 +36,11 @@ class Add(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            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)
         application.add(args.package, args.source, args.without_dependencies)

src/ahriman/application/handlers/backup.py

@@ -41,13 +41,11 @@ class Backup(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            no_report(bool): force disable reporting
-            unsafe(bool): if set no user check will be performed before path creation
         """
         backup_paths = Backup.get_paths(configuration)
         with TarFile(args.path, mode="w") as archive:  # well we don't actually use compression
@@ -58,12 +56,8 @@ class Backup(Handler):
     def get_paths(configuration: Configuration) -> Set[Path]:
         """
         extract paths to backup
-
+        :param configuration: configuration instance
-        Args:
+        :return: map of the filesystem paths
-            configuration(Configuration): configuration instance
-
-        Returns:
-            Set[Path]: map of the filesystem paths
         """
         paths = set(configuration.include.glob("*.ini"))
 

src/ahriman/application/handlers/clean.py

@@ -36,13 +36,11 @@ class Clean(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            no_report(bool): force disable reporting
-            unsafe(bool): if set no user check will be performed before path creation
         """
         Application(architecture, configuration, no_report, unsafe).clean(
             args.cache, args.chroot, args.manual, args.packages)

src/ahriman/application/handlers/dump.py

@@ -38,13 +38,11 @@ class Dump(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            no_report(bool): force disable reporting
-            unsafe(bool): if set no user check will be performed before path creation
         """
         dump = configuration.dump()
         for section, values in sorted(dump.items()):

src/ahriman/application/handlers/handler.py

@@ -34,10 +34,8 @@ from ahriman.models.repository_paths import RepositoryPaths
 class Handler:
     """
     base handler class for command callbacks
-
+    :cvar ALLOW_AUTO_ARCHITECTURE_RUN: allow to define architecture from existing repositories
-    Attributes:
+    :cvar ALLOW_MULTI_ARCHITECTURE_RUN: allow to run with multiple architectures
-        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
     """
 
     ALLOW_AUTO_ARCHITECTURE_RUN = True
@@ -47,15 +45,8 @@ class Handler:
     def architectures_extract(cls: Type[Handler], args: argparse.Namespace) -> List[str]:
         """
         get known architectures
-
+        :param args: command line args
-        Args:
+        :return: list of architectures for which tree is created
-            args(argparse.Namespace): command line args
-
-        Returns:
-            List[str]: list of architectures for which tree is created
-
-        Raises:
-            MissingArchitecture: if no architecture set and automatic detection is not allowed or failed
         """
         if not cls.ALLOW_AUTO_ARCHITECTURE_RUN and args.architecture is None:
             # for some parsers (e.g. config) we need to run with specific architecture
@@ -78,13 +69,9 @@ class Handler:
     def call(cls: Type[Handler], args: argparse.Namespace, architecture: str) -> bool:
         """
         additional function to wrap all calls for multiprocessing library
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :return: True on success, False otherwise
-            architecture(str): repository architecture
-
-        Returns:
-            bool: True on success, False otherwise
         """
         try:
             configuration = Configuration.from_path(args.configuration, architecture, args.quiet)
@@ -102,15 +89,8 @@ class Handler:
     def execute(cls: Type[Handler], args: argparse.Namespace) -> int:
         """
         execute function for all aru
-
+        :param args: command line args
-        Args:
+        :return: 0 on success, 1 otherwise
-            args(argparse.Namespace): command line args
-
-        Returns:
-            int: 0 on success, 1 otherwise
-
-        Raises:
-            MultipleArchitectures: if more than one architecture supplied and no multi architecture supported
         """
         architectures = cls.architectures_extract(args)
 
@@ -132,16 +112,11 @@ class Handler:
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            no_report(bool): force disable reporting
-            unsafe(bool): if set no user check will be performed before path creation
-
-        Raises:
-            NotImplementedError: not implemented method
         """
         raise NotImplementedError
 
@@ -149,13 +124,8 @@ class Handler:
     def check_if_empty(enabled: bool, predicate: bool) -> None:
         """
         check condition and flag and raise ExitCode exception in case if it is enabled and condition match
-
+        :param enabled: if False no check will be performed
-        Args:
+        :param predicate: indicates condition on which exception should be thrown
-            enabled(bool): if False no check will be performed
-            predicate(bool): indicates condition on which exception should be thrown
-
-        Raises:
-            ExitCode: if result is empty and check is enabled
         """
         if enabled and predicate:
             raise ExitCode()

src/ahriman/application/handlers/help.py

@@ -37,13 +37,11 @@ class Help(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            no_report(bool): force disable reporting
-            unsafe(bool): if set no user check will be performed before path creation
         """
         parser: argparse.ArgumentParser = args.parser()
         if args.command is None:

src/ahriman/application/handlers/key_import.py

@@ -38,13 +38,11 @@ class KeyImport(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            no_report(bool): force disable reporting
-            unsafe(bool): if set no user check will be performed before path creation
         """
         Application(architecture, configuration, no_report, unsafe).repository.sign.key_import(
             args.key_server, args.key)

src/ahriman/application/handlers/patch.py

@@ -42,13 +42,11 @@ class Patch(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            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)
 
@@ -63,11 +61,9 @@ class Patch(Handler):
     def patch_set_create(application: Application, sources_dir: str, track: List[str]) -> None:
         """
         create patch set for the package base
-
+        :param application: application instance
-        Args:
+        :param sources_dir: path to directory with the package sources
-            application(Application): application instance
+        :param track: track files which match the glob before creating the patch
-            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.load(sources_dir, PackageSource.Local, application.repository.pacman,
                                application.repository.aur_url)
@@ -78,11 +74,9 @@ class Patch(Handler):
     def patch_set_list(application: Application, package_base: Optional[str], exit_code: bool) -> None:
         """
         list patches available for the package base
-
+        :param application: application instance
-        Args:
+        :param package_base: package base
-            application(Application): application instance
+        :param exit_code: raise ExitCode on empty search result
-            package_base(Optional[str]): package base
-            exit_code(bool): exit with error on empty search result
         """
         patches = application.database.patches_list(package_base)
         Patch.check_if_empty(exit_code, not patches)
@@ -95,9 +89,7 @@ class Patch(Handler):
     def patch_set_remove(application: Application, package_base: str) -> None:
         """
         remove patch set for the package base
-
+        :param application: application instance
-        Args:
+        :param package_base: package base
-            application(Application): application instance
-            package_base(str): package base
         """
         application.database.patches_remove(package_base)

src/ahriman/application/handlers/rebuild.py

@@ -38,13 +38,11 @@ class Rebuild(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            no_report(bool): force disable reporting
-            unsafe(bool): if set no user check will be performed before path creation
         """
         depends_on = set(args.depends_on) if args.depends_on else None
 
@@ -67,11 +65,7 @@ class Rebuild(Handler):
     def extract_packages(application: Application) -> List[Package]:
         """
         extract packages from database file
-
+        :param application: application instance
-        Args:
+        :return: list of packages which were stored in database
-            application(Application): application instance
-
-        Returns:
-            List[Package]: list of packages which were stored in database
         """
         return [package for (package, _) in application.database.packages_get()]

src/ahriman/application/handlers/remove.py

@@ -36,12 +36,10 @@ class Remove(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            no_report(bool): force disable reporting
-            unsafe(bool): if set no user check will be performed before path creation
         """
         Application(architecture, configuration, no_report, unsafe).remove(args.package)

src/ahriman/application/handlers/remove_unknown.py

@@ -37,13 +37,11 @@ class RemoveUnknown(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            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)
         unknown_packages = application.unknown()

src/ahriman/application/handlers/report.py

@@ -37,12 +37,10 @@ class Report(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            no_report(bool): force disable reporting
-            unsafe(bool): if set no user check will be performed before path creation
         """
         Application(architecture, configuration, no_report, unsafe).report(args.target, Result())

src/ahriman/application/handlers/restore.py

@@ -38,13 +38,11 @@ class Restore(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            no_report(bool): force disable reporting
-            unsafe(bool): if set no user check will be performed before path creation
         """
         with TarFile(args.path) as archive:
             archive.extractall(path=args.output)

src/ahriman/application/handlers/search.py

@@ -34,9 +34,7 @@ from ahriman.models.aur_package import AURPackage
 class Search(Handler):
     """
     packages search handler
-
+    :cvar SORT_FIELDS: allowed fields to sort the package list
-    Attributes:
-        SORT_FIELDS(Set[str]): (class attribute) allowed fields to sort the package list
     """
 
     ALLOW_AUTO_ARCHITECTURE_RUN = False  # it should be called only as "no-architecture"
@@ -47,13 +45,11 @@ class Search(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            no_report(bool): force disable reporting
-            unsafe(bool): if set no user check will be performed before path creation
         """
         official_packages_list = Official.multisearch(*args.search)
         aur_packages_list = AUR.multisearch(*args.search)
@@ -68,16 +64,9 @@ class Search(Handler):
     def sort(packages: Iterable[AURPackage], sort_by: str) -> List[AURPackage]:
         """
         sort package list by specified field
-
+        :param packages: packages list to sort
-        Args:
+        :param sort_by: AUR package field name to sort by
-            packages(Iterable[AURPackage]): packages list to sort
+        :return: sorted list for packages
-            sort_by(str): AUR package field name to sort by
-
-        Returns:
-            List[AURPackage]: sorted list for packages
-
-        Raises:
-            InvalidOption: if search fields is not in list of allowed ones
         """
         if sort_by not in Search.SORT_FIELDS:
             raise InvalidOption(sort_by)

src/ahriman/application/handlers/setup.py

@@ -31,12 +31,10 @@ from ahriman.models.repository_paths import RepositoryPaths
 class Setup(Handler):
     """
     setup handler
-
+    :cvar ARCHBUILD_COMMAND_PATH: default devtools command
-    Attributes:
+    :cvar BIN_DIR_PATH: directory for custom binaries
-        ARCHBUILD_COMMAND_PATH(Path): (class attribute) default devtools command
+    :cvar MIRRORLIST_PATH: path to pacman default mirrorlist (used by multilib repository)
-        BIN_DIR_PATH(Path): (class attribute) directory for custom binaries
+    :cvar SUDOERS_PATH: path to sudoers.d include configuration
-        MIRRORLIST_PATH(Path): (class attribute) path to pacman default mirrorlist (used by multilib repository)
-        SUDOERS_PATH(Path): (class attribute) path to sudoers.d include configuration
     """
 
     ALLOW_AUTO_ARCHITECTURE_RUN = False
@@ -51,13 +49,11 @@ class Setup(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            no_report(bool): force disable reporting
-            unsafe(bool): if set no user check will be performed before path creation
         """
         Setup.configuration_create_ahriman(args, architecture, args.repository, configuration.include)
         configuration.reload()
@@ -76,13 +72,9 @@ class Setup(Handler):
     def build_command(prefix: str, architecture: str) -> Path:
         """
         generate build command name
-
+        :param prefix: command prefix in {prefix}-{architecture}-build
-        Args:
+        :param architecture: repository architecture
-            prefix(str): command prefix in {prefix}-{architecture}-build
+        :return: valid devtools command name
-            architecture(str): repository architecture
-
-        Returns:
-            Path: valid devtools command name
         """
         return Setup.BIN_DIR_PATH / f"{prefix}-{architecture}-build"
 
@@ -91,12 +83,10 @@ class Setup(Handler):
                                      include_path: Path) -> None:
         """
         create service specific configuration
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param repository: repository name
-            architecture(str): repository architecture
+        :param include_path: path to directory with configuration includes
-            repository(str): repository name
-            include_path(Path): path to directory with configuration includes
         """
         configuration = Configuration()
 
@@ -124,14 +114,12 @@ class Setup(Handler):
                                       no_multilib: bool, repository: str, paths: RepositoryPaths) -> None:
         """
         create configuration for devtools based on `source` configuration
-
+        :param prefix: command prefix in {prefix}-{architecture}-build
-        Args:
+        :param architecture: repository architecture
-            prefix(str): command prefix in {prefix}-{architecture}-build
+        :param source: path to source configuration file
-            architecture(str): repository architecture
+        :param no_multilib: do not add multilib repository
-            source(Path): path to source configuration file
+        :param repository: repository name
-            no_multilib(bool): do not add multilib repository
+        :param paths: repository paths instance
-            repository(str): repository name
-            paths(RepositoryPaths): repository paths instance
         """
         configuration = Configuration()
         # preserve case
@@ -161,10 +149,8 @@ class Setup(Handler):
     def configuration_create_makepkg(packager: str, paths: RepositoryPaths) -> None:
         """
         create configuration for makepkg
-
+        :param packager: packager identifier (e.g. name, email)
-        Args:
+        :param paths: repository paths instance
-            packager(str): packager identifier (e.g. name, email)
-            paths(RepositoryPaths): repository paths instance
         """
         (paths.root / ".makepkg.conf").write_text(f"PACKAGER='{packager}'\n", encoding="utf8")
 
@@ -172,10 +158,8 @@ class Setup(Handler):
     def configuration_create_sudo(prefix: str, architecture: str) -> None:
         """
         create configuration to run build command with sudo without password
-
+        :param prefix: command prefix in {prefix}-{architecture}-build
-        Args:
+        :param architecture: repository architecture
-            prefix(str): command prefix in {prefix}-{architecture}-build
-            architecture(str): repository architecture
         """
         command = Setup.build_command(prefix, architecture)
         Setup.SUDOERS_PATH.write_text(f"ahriman ALL=(ALL) NOPASSWD: {command} *\n", encoding="utf8")
@@ -185,10 +169,8 @@ class Setup(Handler):
     def executable_create(prefix: str, architecture: str) -> None:
         """
         create executable for the service
-
+        :param prefix: command prefix in {prefix}-{architecture}-build
-        Args:
+        :param architecture: repository architecture
-            prefix(str): command prefix in {prefix}-{architecture}-build
-            architecture(str): repository architecture
         """
         command = Setup.build_command(prefix, architecture)
         command.unlink(missing_ok=True)

src/ahriman/application/handlers/sign.py

@@ -36,12 +36,10 @@ class Sign(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            no_report(bool): force disable reporting
-            unsafe(bool): if set no user check will be performed before path creation
         """
         Application(architecture, configuration, no_report, unsafe).sign(args.package)

src/ahriman/application/handlers/status.py

@@ -42,13 +42,11 @@ class Status(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            no_report(bool): force disable reporting
-            unsafe(bool): if set no user check will be performed before path creation
         """
         # we are using reporter here
         client = Application(architecture, configuration, no_report=False, unsafe=unsafe).repository.reporter

src/ahriman/application/handlers/status_update.py

@@ -39,13 +39,11 @@ class StatusUpdate(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            no_report(bool): force disable reporting
-            unsafe(bool): if set no user check will be performed before path creation
         """
         # we are using reporter here
         client = Application(architecture, configuration, no_report=False, unsafe=unsafe).repository.reporter

src/ahriman/application/handlers/sync.py

@@ -28,7 +28,7 @@ from ahriman.core.configuration import Configuration
 
 class Sync(Handler):
     """
-    remote sync handler
+    remove sync handler
     """
 
     @classmethod
@@ -36,12 +36,10 @@ class Sync(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            no_report(bool): force disable reporting
-            unsafe(bool): if set no user check will be performed before path creation
         """
         Application(architecture, configuration, no_report, unsafe).sync(args.target, [])

src/ahriman/application/handlers/unsafe_commands.py

@@ -24,6 +24,7 @@ from typing import List, Type
 
 from ahriman.application.handlers.handler import Handler
 from ahriman.core.configuration import Configuration
+from ahriman.core.exceptions import ExitCode
 from ahriman.core.formatters.string_printer import StringPrinter
 
 
@@ -39,13 +40,11 @@ class UnsafeCommands(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            no_report(bool): force disable reporting
-            unsafe(bool): if set no user check will be performed before path creation
         """
         parser = args.parser()
         unsafe_commands = UnsafeCommands.get_unsafe_commands(parser)
@@ -59,25 +58,20 @@ class UnsafeCommands(Handler):
     def check_unsafe(command: str, unsafe_commands: List[str], parser: argparse.ArgumentParser) -> None:
         """
         check if command is unsafe
-
+        :param command: command to check
-        Args:
+        :param unsafe_commands: list of unsafe commands
-            command(str): command to check
+        :param parser: generated argument parser
-            unsafe_commands(List[str]): list of unsafe commands
-            parser(argparse.ArgumentParser): generated argument parser
         """
         args = parser.parse_args(shlex.split(command))
-        UnsafeCommands.check_if_empty(True, args.command in unsafe_commands)
+        if args.command in unsafe_commands:
+            raise ExitCode()
 
     @staticmethod
     def get_unsafe_commands(parser: argparse.ArgumentParser) -> List[str]:
         """
         extract unsafe commands from argument parser
-
+        :param parser: generated argument parser
-        Args:
+        :return: list of commands with default unsafe flag
-            parser(argparse.ArgumentParser): generated argument parser
-
-        Returns:
-            List[str]: list of commands with default unsafe flag
         """
         # pylint: disable=protected-access
         subparser = next(action for action in parser._actions if isinstance(action, argparse._SubParsersAction))

src/ahriman/application/handlers/update.py

@@ -36,13 +36,11 @@ class Update(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            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)
         packages = application.updates(args.package, args.no_aur, args.no_local, args.no_manual, args.no_vcs,
@@ -58,13 +56,9 @@ class Update(Handler):
     def log_fn(application: Application, dry_run: bool) -> Callable[[str], None]:
         """
         package updates log function
-
+        :param application: application instance
-        Args:
+        :param dry_run: do not perform update itself
-            application(Application): application instance
+        :return: in case if dry_run is set it will return print, logger otherwise
-            dry_run(bool): do not perform update itself
-
-        Returns:
-            Callable[[str], None]: in case if dry_run is set it will return print, logger otherwise
         """
         def inner(line: str) -> None:
             return print(line) if dry_run else application.logger.info(line)

src/ahriman/application/handlers/user.py

@@ -43,13 +43,11 @@ class User(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            no_report(bool): force disable reporting
-            unsafe(bool): if set no user check will be performed before path creation
         """
         database = SQLite.load(configuration)
 
@@ -74,13 +72,11 @@ class User(Handler):
                              as_service_user: bool, secure: bool) -> None:
         """
         enable configuration if it has been disabled
-
+        :param configuration: configuration instance
-        Args:
+        :param user: user descriptor
-            configuration(Configuration): configuration instance
+        :param salt: password hash salt
-            user(MUser): user descriptor
+        :param as_service_user: add user as service user, also set password and user to configuration
-            salt(str): password hash salt
+        :param secure: if true then set file permissions to 0o600
-            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
         """
         configuration.set_option("auth", "salt", salt)
         if as_service_user:
@@ -92,12 +88,8 @@ class User(Handler):
     def configuration_get(include_path: Path) -> Configuration:
         """
         create configuration instance
-
+        :param include_path: path to directory with configuration includes
-        Args:
+        :return: configuration instance. In case if there are local settings they will be loaded
-            include_path(Path): path to directory with configuration includes
-
-        Returns:
-            Configuration: configuration instance. In case if there are local settings they will be loaded
         """
         target = include_path / "auth.ini"
         configuration = Configuration()
@@ -111,10 +103,8 @@ class User(Handler):
     def configuration_write(configuration: Configuration, secure: bool) -> None:
         """
         write configuration file
-
+        :param configuration: configuration instance
-        Args:
+        :param secure: if true then set file permissions to 0o600
-            configuration(Configuration): configuration instance
-            secure(bool): if true then set file permissions to 0o600
         """
         path, _ = configuration.check_loaded()
         with path.open("w") as ahriman_configuration:
@@ -126,13 +116,9 @@ class User(Handler):
     def get_salt(configuration: Configuration, salt_length: int = 20) -> str:
         """
         get salt from configuration or create new string
-
+        :param configuration: configuration instance
-        Args:
+        :param salt_length: salt length
-            configuration(Configuration): configuration instance
+        :return: current salt
-            salt_length(int, optional): salt length (Default value = 20)
-
-        Returns:
-            str: current salt
         """
         if salt := configuration.get("auth", "salt", fallback=None):
             return salt
@@ -142,12 +128,8 @@ class User(Handler):
     def user_create(args: argparse.Namespace) -> MUser:
         """
         create user descriptor from arguments
-
+        :param args: command line args
-        Args:
+        :return: built user descriptor
-            args(argparse.Namespace): command line args
-
-        Returns:
-            MUser: built user descriptor
         """
         user = MUser(args.username, args.password, args.role)
         if user.password is None:

src/ahriman/application/handlers/web.py

@@ -39,13 +39,11 @@ class Web(Handler):
             configuration: Configuration, no_report: bool, unsafe: bool) -> None:
         """
         callback for command line
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param no_report: force disable reporting
-            configuration(Configuration): configuration instance
+        :param unsafe: if set no user check will be performed before path creation
-            no_report(bool): force disable reporting
-            unsafe(bool): if set no user check will be performed before path creation
         """
         # we are using local import for optional dependencies
         from ahriman.web.web import run_server, setup_service

src/ahriman/application/lock.py

@@ -37,23 +37,19 @@ from ahriman.models.build_status import BuildStatusEnum
 class Lock:
     """
     wrapper for application lock file
-
+    :ivar force: remove lock file on start if any
-    Attributes:
+    :ivar path: path to lock file if any
-        force(bool): remove lock file on start if any
+    :ivar reporter: build status reporter instance
-        path(Path): path to lock file if any
+    :ivar paths: repository paths instance
-        reporter(Client): build status reporter instance
+    :ivar unsafe: skip user check
-        paths(RepositoryPaths): repository paths instance
-        unsafe(bool): skip user check
     """
 
     def __init__(self, args: argparse.Namespace, architecture: str, configuration: Configuration) -> None:
         """
         default constructor
-
+        :param args: command line args
-        Args:
+        :param architecture: repository architecture
-            args(argparse.Namespace): command line args
+        :param configuration: configuration instance
-            architecture(str): repository architecture
-            configuration(Configuration): configuration instance
         """
         self.path = Path(f"{args.lock}_{architecture}") if args.lock is not None else None
         self.force = args.force
@@ -66,11 +62,11 @@ class Lock:
         """
         default workflow is the following:
 
-            1. Check user UID
+            check user UID
-            2. Check if there is lock file
+            check if there is lock file
-            3. Check web status watcher status
+            check web status watcher status
-            4. Create lock file
+            create lock file
-            5. Report to status page if enabled
+            report to web if enabled
         """
         self.check_user()
         self.check_version()
@@ -82,14 +78,10 @@ class Lock:
                  exc_tb: TracebackType) -> Literal[False]:
         """
         remove lock file when done
-
+        :param exc_type: exception type name if any
-        Args:
+        :param exc_val: exception raised if any
-            exc_type(Optional[Type[Exception]]): exception type name if any
+        :param exc_tb: exception traceback if any
-            exc_val(Optional[Exception]): exception raised if any
+        :return: always False (do not suppress any exception)
-            exc_tb(TracebackType): exception traceback if any
-
-        Returns:
-            Literal[False]: always False (do not suppress any exception)
         """
         self.clear()
         status = BuildStatusEnum.Success if exc_val is None else BuildStatusEnum.Failed
@@ -124,9 +116,6 @@ class Lock:
     def create(self) -> None:
         """
         create lock file
-
-        Raises:
-            DuplicateRun: if lock exists and no force flag supplied
         """
         if self.path is None:
             return

src/ahriman/core/alpm/pacman.py

@@ -26,17 +26,13 @@ from ahriman.core.configuration import Configuration
 class Pacman:
     """
     alpm wrapper
-
+    :ivar handle: pyalpm root `Handle`
-    Attributes:
-        handle(Handle): pyalpm root `Handle`
     """
 
     def __init__(self, configuration: Configuration) -> None:
         """
         default constructor
-
+        :param configuration: configuration instance
-        Args:
-            configuration(Configuration): configuration instance
         """
         root = configuration.get("alpm", "root")
         pacman_root = configuration.getpath("alpm", "database")
@@ -47,9 +43,7 @@ class Pacman:
     def all_packages(self) -> Set[str]:
         """
         get list of packages known for alpm
-
+        :return: list of package names
-        Returns:
-            Set[str]: list of package names
         """
         result: Set[str] = set()
         for database in self.handle.get_syncdbs():

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

@@ -30,12 +30,10 @@ from ahriman.models.aur_package import AURPackage
 class AUR(Remote):
     """
     AUR RPC wrapper
-
+    :cvar DEFAULT_RPC_URL: default AUR RPC url
-    Attributes:
+    :cvar DEFAULT_RPC_VERSION: default AUR RPC version
-        DEFAULT_RPC_URL(str): (class attribute) default AUR RPC url
+    :ivar rpc_url: AUR RPC url
-        DEFAULT_RPC_VERSION(str): (class attribute) default AUR RPC version
+    :ivar rpc_version: AUR RPC version
-        rpc_url(str): AUR RPC url
-        rpc_version(str): AUR RPC version
     """
 
     DEFAULT_RPC_URL = "https://aur.archlinux.org/rpc"
@@ -44,10 +42,8 @@ class AUR(Remote):
     def __init__(self, rpc_url: Optional[str] = None, rpc_version: Optional[str] = None) -> None:
         """
         default constructor
-
+        :param rpc_url: AUR RPC url
-        Args:
+        :param rpc_version: AUR RPC version
-            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
@@ -57,15 +53,8 @@ class AUR(Remote):
     def parse_response(response: Dict[str, Any]) -> List[AURPackage]:
         """
         parse RPC response to package list
-
+        :param response: RPC response json
-        Args:
+        :return: list of parsed packages
-            response(Dict[str, Any]): RPC response json
-
-        Returns:
-            List[AURPackage]: list of parsed packages
-
-        Raises:
-            InvalidPackageInfo: for error API response
         """
         response_type = response["type"]
         if response_type == "error":
@@ -76,14 +65,10 @@ class AUR(Remote):
     def make_request(self, request_type: str, *args: str, **kwargs: str) -> List[AURPackage]:
         """
         perform request to AUR RPC
-
+        :param request_type: AUR request type, e.g. search, info
-        Args:
+        :param args: list of arguments to be passed as args query parameter
-            request_type(str): AUR request type, e.g. search, info
+        :param kwargs: list of additional named parameters like by
-            *args(str): list of arguments to be passed as args query parameter
+        :return: response parsed to package list
-            **kwargs(str): list of additional named parameters like by
-
-        Returns:
-            List[AURPackage]: response parsed to package list
         """
         query: Dict[str, Any] = {
             "type": request_type,
@@ -113,12 +98,8 @@ class AUR(Remote):
     def package_info(self, package_name: str) -> AURPackage:
         """
         get package info by its name
-
+        :param package_name: package name to search
-        Args:
+        :return: package which match the package name
-            package_name(str): package name to search
-
-        Returns:
-            AURPackage: package which match the package name
         """
         packages = self.make_request("info", package_name)
         return next(package for package in packages if package.name == package_name)
@@ -126,11 +107,7 @@ class AUR(Remote):
     def package_search(self, *keywords: str) -> List[AURPackage]:
         """
         search package in AUR web
-
+        :param keywords: keywords to search
-        Args:
+        :return: list of packages which match the criteria
-            *keywords(str): keywords to search
-
-        Returns:
-            List[AURPackage]: list of packages which match the criteria
         """
         return self.make_request("search", *keywords, by="name-desc")

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

@@ -30,10 +30,8 @@ from ahriman.models.aur_package import AURPackage
 class Official(Remote):
     """
     official repository RPC wrapper
-
+    :cvar DEFAULT_RPC_URL: default AUR RPC url
-    Attributes:
+    :ivar rpc_url: AUR RPC url
-        DEFAULT_RPC_URL(str): (class attribute) default AUR RPC url
-        rpc_url(str): AUR RPC url
     """
 
     DEFAULT_RPC_URL = "https://archlinux.org/packages/search/json"
@@ -41,9 +39,7 @@ class Official(Remote):
     def __init__(self, rpc_url: Optional[str] = None) -> None:
         """
         default constructor
-
+        :param rpc_url: AUR RPC url
-        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
@@ -52,15 +48,8 @@ class Official(Remote):
     def parse_response(response: Dict[str, Any]) -> List[AURPackage]:
         """
         parse RPC response to package list
-
+        :param response: RPC response json
-        Args:
+        :return: list of parsed packages
-            response(Dict[str, Any]): RPC response json
-
-        Returns:
-            List[AURPackage]: list of parsed packages
-
-        Raises:
-            InvalidPackageInfo: for error API response
         """
         if not response["valid"]:
             raise InvalidPackageInfo("API validation error")
@@ -69,13 +58,9 @@ class Official(Remote):
     def make_request(self, *args: str, by: str) -> List[AURPackage]:
         """
         perform request to official repositories RPC
-
+        :param args: list of arguments to be passed as args query parameter
-        Args:
+        :param by: search by the field
-            *args(str): list of arguments to be passed as args query parameter
+        :return: response parsed to package list
-            by(str): search by the field
-
-        Returns:
-            List[AURPackage]: response parsed to package list
         """
         try:
             response = requests.get(self.rpc_url, params={by: args})
@@ -91,12 +76,8 @@ class Official(Remote):
     def package_info(self, package_name: str) -> AURPackage:
         """
         get package info by its name
-
+        :param package_name: package name to search
-        Args:
+        :return: package which match the package name
-            package_name(str): package name to search
-
-        Returns:
-            AURPackage: package which match the package name
         """
         packages = self.make_request(package_name, by="name")
         return next(package for package in packages if package.name == package_name)
@@ -104,11 +85,7 @@ class Official(Remote):
     def package_search(self, *keywords: str) -> List[AURPackage]:
         """
         search package in AUR web
-
+        :param keywords: keywords to search
-        Args:
+        :return: list of packages which match the criteria
-            *keywords(str): keywords to search
-
-        Returns:
-            List[AURPackage]: list of packages which match the criteria
         """
         return self.make_request(*keywords, by="q")

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

@@ -29,9 +29,7 @@ from ahriman.models.aur_package import AURPackage
 class Remote:
     """
     base class for remote package search
-
+    :ivar logger: class logger
-    Attributes:
-        logger(logging.Logger): class logger
     """
 
     def __init__(self) -> None:
@@ -44,12 +42,8 @@ class Remote:
     def info(cls: Type[Remote], package_name: str) -> AURPackage:
         """
         get package info by its name
-
+        :param package_name: package name to search
-        Args:
+        :return: package which match the package name
-            package_name(str): package name to search
-
-        Returns:
-            AURPackage: package which match the package name
         """
         return cls().package_info(package_name)
 
@@ -58,12 +52,8 @@ class Remote:
         """
         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
-
+        :param keywords: search terms, e.g. "ahriman", "is", "cool"
-        Args:
+        :return: list of packages each of them matches all search terms
-            *keywords(str): search terms, e.g. "ahriman", "is", "cool"
-
-        Returns:
-            List[AURPackage]: list of packages each of them matches all search terms
         """
         instance = cls()
         packages: Dict[str, AURPackage] = {}
@@ -80,41 +70,23 @@ class Remote:
     def search(cls: Type[Remote], *keywords: str) -> List[AURPackage]:
         """
         search package in AUR web
-
+        :param keywords: keywords to search
-        Args:
+        :return: list of packages which match the criteria
-            *keywords(str): search terms, e.g. "ahriman", "is", "cool"
-
-        Returns:
-            List[AURPackage]: list of packages which match the criteria
         """
         return cls().package_search(*keywords)
 
     def package_info(self, package_name: str) -> AURPackage:
         """
         get package info by its name
-
+        :param package_name: package name to search
-        Args:
+        :return: package which match the package name
-            package_name(str): package name to search
-
-        Returns:
-            AURPackage: package which match the package name
-
-        Raises:
-            NotImplementedError: not implemented method
         """
         raise NotImplementedError
 
     def package_search(self, *keywords: str) -> List[AURPackage]:
         """
         search package in AUR web
-
+        :param keywords: keywords to search
-        Args:
+        :return: list of packages which match the criteria
-            *keywords(str): keywords to search
-
-        Returns:
-            List[AURPackage]: list of packages which match the criteria
-
-        Raises:
-            NotImplementedError: not implemented method
         """
         raise NotImplementedError

src/ahriman/core/alpm/repo.py

@@ -30,13 +30,11 @@ from ahriman.models.repository_paths import RepositoryPaths
 class Repo:
     """
     repo-add and repo-remove wrapper
-
+    :ivar logger: class logger
-    Attributes:
+    :ivar name: repository name
-        logger(logging.Logger): class logger
+    :ivar paths: repository paths instance
-        name(str): repository name
+    :ivar sign_args: additional args which have to be used to sign repository archive
-        paths(RepositoryPaths): repository paths instance
+    :ivar uid: uid of the repository owner user
-        sign_args(List[str]): additional args which have to be used to sign repository archive
-        uid(int): uid of the repository owner user
     """
 
     _check_output = check_output
@@ -44,11 +42,9 @@ class Repo:
     def __init__(self, name: str, paths: RepositoryPaths, sign_args: List[str]) -> None:
         """
         default constructor
-
+        :param name: repository name
-        Args:
+        :param paths: repository paths instance
-            name(str): repository name
+        :param sign_args: additional args which have to be used to sign repository archive
-            paths(RepositoryPaths): repository paths instance
-            sign_args(List[str]): additional args which have to be used to sign repository archive
         """
         self.logger = logging.getLogger("build_details")
         self.name = name
@@ -59,19 +55,14 @@ class Repo:
     @property
     def repo_path(self) -> Path:
         """
-        get full path to the repository database
+        :return: path to repository database
-
-        Returns:
-            Path: path to repository database
         """
         return self.paths.repository / f"{self.name}.db.tar.gz"
 
     def add(self, path: Path) -> None:
         """
         add new package to repository
-
+        :param path: path to archive to add
-        Args:
-            path(Path): path to archive to add
         """
         Repo._check_output(
             "repo-add", *self.sign_args, "-R", str(self.repo_path), str(path),
@@ -94,10 +85,8 @@ class Repo:
     def remove(self, package: str, filename: Path) -> None:
         """
         remove package from repository
-
+        :param package: package name to remove
-        Args:
+        :param filename: package filename to remove
-            package(str): package name to remove
-            filename(Path): package filename to remove
         """
         # remove package and signature (if any) from filesystem
         for full_path in self.paths.repository.glob(f"{filename}*"):

src/ahriman/core/auth/auth.py

@@ -32,21 +32,16 @@ from ahriman.models.user_access import UserAccess
 class Auth:
     """
     helper to deal with user authorization
-
+    :ivar enabled: indicates if authorization is enabled
-    Attributes:
+    :ivar max_age: session age in seconds. It will be used for both client side and server side checks
-        enabled(bool): indicates if authorization is enabled
+    :ivar safe_build_status: allow read only access to the index page
-        logger(logging.Logger): class logger
-        max_age(int): session age in seconds. It will be used for both client side and server side checks
-        safe_build_status(bool): allow read only access to the index page
     """
 
     def __init__(self, configuration: Configuration, provider: AuthSettings = AuthSettings.Disabled) -> None:
         """
         default constructor
-
+        :param configuration: configuration instance
-        Args:
+        :param provider: authorization type definition
-            configuration(Configuration): configuration instance
-            provider(AuthSettings, optional): authorization type definition (Default value = AuthSettings.Disabled)
         """
         self.logger = logging.getLogger("http")
 
@@ -62,9 +57,7 @@ class Auth:
         In case of internal authentication it must provide an interface (modal form) to login with button sends POST
         request. But for an external providers behaviour can be different: e.g. OAuth provider requires sending GET
         request to external resource
-
+        :return: login control as html code to insert
-        Returns:
-            str: login control as html code to insert
         """
         return """<button type="button" class="btn btn-link" data-bs-toggle="modal" data-bs-target="#loginForm" style="text-decoration: none">login</button>"""
 
@@ -72,13 +65,9 @@ class Auth:
     def load(cls: Type[Auth], configuration: Configuration, database: SQLite) -> Auth:
         """
         load authorization module from settings
-
+        :param configuration: configuration instance
-        Args:
+        :param database: database instance
-            configuration(Configuration): configuration instance
+        :return: authorization module according to current settings
-            database(SQLite): database instance
-
-        Returns:
-            Auth: authorization module according to current settings
         """
         provider = AuthSettings.from_option(configuration.get("auth", "target", fallback="disabled"))
         if provider == AuthSettings.Configuration:
@@ -92,13 +81,9 @@ class Auth:
     async def check_credentials(self, username: Optional[str], password: Optional[str]) -> bool:  # pylint: disable=no-self-use
         """
         validate user password
-
+        :param username: username
-        Args:
+        :param password: entered password
-            username(Optional[str]): username
+        :return: True in case if password matches, False otherwise
-            password(Optional[str]): entered password
-
-        Returns:
-            bool: True in case if password matches, False otherwise
         """
         del username, password
         return True
@@ -106,12 +91,8 @@ class Auth:
     async def known_username(self, username: Optional[str]) -> bool:  # pylint: disable=no-self-use
         """
         check if user is known
-
+        :param username: username
-        Args:
+        :return: True in case if user is known and can be authorized and False otherwise
-            username(Optional[str]): username
-
-        Returns:
-            bool: True in case if user is known and can be authorized and False otherwise
         """
         del username
         return True
@@ -119,14 +100,10 @@ class Auth:
     async def verify_access(self, username: str, required: UserAccess, context: Optional[str]) -> bool:  # pylint: disable=no-self-use
         """
         validate if user has access to requested resource
-
+        :param username: username
-        Args:
+        :param required: required access level
-            username(str): username
+        :param context: URI request path
-            required(UserAccess): required access level
+        :return: True in case if user is allowed to do this request and False otherwise
-            context(Optional[str]): URI request path
-
-        Returns:
-            bool: True in case if user is allowed to do this request and False otherwise
         """
         del username, required, context
         return True

src/ahriman/core/auth/helpers.py

@@ -29,12 +29,8 @@ except ImportError:
 async def authorized_userid(*args: Any) -> Any:
     """
     handle aiohttp security methods
-
+    :param args: argument list as provided by authorized_userid function
-    Args:
+    :return: None in case if no aiohttp_security module found and function call otherwise
-        *args(Any): argument list as provided by authorized_userid function
-
-    Returns:
-        Any: None in case if no aiohttp_security module found and function call otherwise
     """
     if _has_aiohttp_security:
         return await aiohttp_security.authorized_userid(*args)  # pylint: disable=no-value-for-parameter
@@ -44,12 +40,8 @@ async def authorized_userid(*args: Any) -> Any:
 async def check_authorized(*args: Any) -> Any:
     """
     handle aiohttp security methods
-
+    :param args: argument list as provided by check_authorized function
-    Args:
+    :return: None in case if no aiohttp_security module found and function call otherwise
-        *args(Any): argument list as provided by check_authorized function
-
-    Returns:
-        Any: None in case if no aiohttp_security module found and function call otherwise
     """
     if _has_aiohttp_security:
         return await aiohttp_security.check_authorized(*args)  # pylint: disable=no-value-for-parameter
@@ -59,12 +51,8 @@ async def check_authorized(*args: Any) -> Any:
 async def forget(*args: Any) -> Any:
     """
     handle aiohttp security methods
-
+    :param args: argument list as provided by forget function
-    Args:
+    :return: None in case if no aiohttp_security module found and function call otherwise
-        *args(Any): argument list as provided by forget function
-
-    Returns:
-        Any: None in case if no aiohttp_security module found and function call otherwise
     """
     if _has_aiohttp_security:
         return await aiohttp_security.forget(*args)  # pylint: disable=no-value-for-parameter
@@ -74,12 +62,8 @@ async def forget(*args: Any) -> Any:
 async def remember(*args: Any) -> Any:
     """
     handle disabled auth
-
+    :param args: argument list as provided by remember function
-    Args:
+    :return: None in case if no aiohttp_security module found and function call otherwise
-        *args(Any): argument list as provided by remember function
-
-    Returns:
-        Any: None in case if no aiohttp_security module found and function call otherwise
     """
     if _has_aiohttp_security:
         return await aiohttp_security.remember(*args)  # pylint: disable=no-value-for-parameter

src/ahriman/core/auth/mapping.py

@@ -31,21 +31,17 @@ from ahriman.models.user_access import UserAccess
 class Mapping(Auth):
     """
     user authorization based on mapping from configuration file
-
+    :ivar salt: random generated string to salt passwords
-    Attributes:
+    :ivar database: database instance
-        salt(str): random generated string to salt passwords
-        database(SQLite): database instance
     """
 
     def __init__(self, configuration: Configuration, database: SQLite,
                  provider: AuthSettings = AuthSettings.Configuration) -> None:
         """
         default constructor
-
+        :param configuration: configuration instance
-        Args:
+        :param database: database instance
-            configuration(Configuration): configuration instance
+        :param provider: authorization type definition
-            database(SQLite): database instance
-            provider(AuthSettings, optional): authorization type definition (Default value = AuthSettings.Configuration)
         """
         Auth.__init__(self, configuration, provider)
         self.database = database
@@ -54,13 +50,9 @@ class Mapping(Auth):
     async def check_credentials(self, username: Optional[str], password: Optional[str]) -> bool:
         """
         validate user password
-
+        :param username: username
-        Args:
+        :param password: entered password
-            username(Optional[str]): username
+        :return: True in case if password matches, False otherwise
-            password(Optional[str]): entered password
-
-        Returns:
-            bool: True in case if password matches, False otherwise
         """
         if username is None or password is None:
             return False  # invalid data supplied
@@ -70,38 +62,26 @@ class Mapping(Auth):
     def get_user(self, username: str) -> Optional[User]:
         """
         retrieve user from in-memory mapping
-
+        :param username: username
-        Args:
+        :return: user descriptor if username is known and None otherwise
-            username(str): username
-
-        Returns:
-            Optional[User]: user descriptor if username is known and None otherwise
         """
         return self.database.user_get(username)
 
     async def known_username(self, username: Optional[str]) -> bool:
         """
         check if user is known
-
+        :param username: username
-        Args:
+        :return: True in case if user is known and can be authorized and False otherwise
-            username(Optional[str]): username
-
-        Returns:
-            bool: True in case if user is known and can be authorized and False otherwise
         """
         return username is not None and self.get_user(username) is not None
 
     async def verify_access(self, username: str, required: UserAccess, context: Optional[str]) -> bool:
         """
         validate if user has access to requested resource
-
+        :param username: username
-        Args:
+        :param required: required access level
-            username(str): username
+        :param context: URI request path
-            required(UserAccess): required access level
+        :return: True in case if user is allowed to do this request and False otherwise
-            context(Optional[str]): URI request path
-
-        Returns:
-            bool: True in case if user is allowed to do this request and False otherwise
         """
         user = self.get_user(username)
         return user is not None and user.verify_access(required)

src/ahriman/core/auth/oauth.py

@@ -32,24 +32,20 @@ class OAuth(Mapping):
     """
     OAuth user authorization.
     It is required to create application first and put application credentials.
-
+    :ivar client_id: application client id
-    Attributes:
+    :ivar client_secret: application client secret key
-        client_id(str): application client id
+    :ivar provider: provider class, should be one of aiohttp-client provided classes
-        client_secret(str): application client secret key
+    :ivar redirect_uri: redirect URI registered in provider
-        provider(aioauth_client.OAuth2Client): provider class, should be one of aiohttp-client provided classes
+    :ivar scopes: list of scopes required by the application
-        redirect_uri(str): redirect URI registered in provider
-        scopes(str): list of scopes required by the application
     """
 
     def __init__(self, configuration: Configuration, database: SQLite,
                  provider: AuthSettings = AuthSettings.OAuth) -> None:
         """
         default constructor
-
+        :param configuration: configuration instance
-        Args:
+        :param database: database instance
-            configuration(Configuration): configuration instance
+        :param provider: authorization type definition
-            database(SQLite): database instance
-            provider(AuthSettings, optional): authorization type definition (Default value = AuthSettings.OAuth)
         """
         Mapping.__init__(self, configuration, database, provider)
         self.client_id = configuration.get("auth", "client_id")
@@ -64,10 +60,7 @@ class OAuth(Mapping):
     @property
     def auth_control(self) -> str:
         """
-        get authorization html control
+        :return: login control as html code to insert
-
-        Returns:
-            str: login control as html code to insert
         """
         return """<a class="nav-link" href="/user-api/v1/login" title="login via OAuth2">login</a>"""
 
@@ -75,15 +68,8 @@ class OAuth(Mapping):
     def get_provider(name: str) -> Type[aioauth_client.OAuth2Client]:
         """
         load OAuth2 provider by name
-
+        :param name: name of the provider. Must be valid class defined in aioauth-client library
-        Args:
+        :return: loaded provider type
-            name(str): name of the provider. Must be valid class defined in aioauth-client library
-
-        Returns:
-            Type[aioauth_client.OAuth2Client]: loaded provider type
-
-        Raises:
-            InvalidOption: in case if invalid OAuth provider name supplied
         """
         provider: Type[aioauth_client.OAuth2Client] = getattr(aioauth_client, name)
         try:
@@ -97,18 +83,14 @@ class OAuth(Mapping):
     def get_client(self) -> aioauth_client.OAuth2Client:
         """
         load client from parameters
-
+        :return: generated client according to current settings
-        Returns:
-            aioauth_client.OAuth2Client: generated client according to current settings
         """
         return self.provider(client_id=self.client_id, client_secret=self.client_secret)
 
     def get_oauth_url(self) -> str:
         """
         get authorization URI for the specified settings
-
+        :return: authorization URI as a string
-        Returns:
-            str: authorization URI as a string
         """
         client = self.get_client()
         uri: str = client.get_authorize_url(scope=self.scopes, redirect_uri=self.redirect_uri)
@@ -117,12 +99,8 @@ class OAuth(Mapping):
     async def get_oauth_username(self, code: str) -> Optional[str]:
         """
         extract OAuth username from remote
-
+        :param code: authorization code provided by external service
-        Args:
+        :return: username as is in OAuth provider
-            code(str): authorization code provided by external service
-
-        Returns:
-            Optional[str]: username as is in OAuth provider
         """
         try:
             client = self.get_client()

src/ahriman/core/build_tools/sources.py

@@ -28,9 +28,7 @@ from ahriman.core.util import check_output
 class Sources:
     """
     helper to download package sources (PKGBUILD etc)
-
+    :cvar logger: class logger
-    Attributes:
-        logger(logging.Logger): (class attribute) class logger
     """
 
     logger = logging.getLogger("build_details")
@@ -42,10 +40,8 @@ class Sources:
     def add(sources_dir: Path, *pattern: str) -> None:
         """
         track found files via git
-
+        :param sources_dir: local path to git repository
-        Args:
+        :param pattern: glob patterns
-            sources_dir(Path): local path to git repository
-            *pattern(str): glob patterns
         """
         # glob directory to find files which match the specified patterns
         found_files: List[Path] = []
@@ -63,12 +59,8 @@ class Sources:
     def diff(sources_dir: Path) -> str:
         """
         generate diff from the current version and write it to the output file
-
+        :param sources_dir: local path to git repository
-        Args:
+        :return: patch as plain string
-            sources_dir(Path): local path to git repository
-
-        Returns:
-            str: patch as plain string
         """
         return Sources._check_output("git", "diff", exception=None, cwd=sources_dir, logger=Sources.logger)
 
@@ -76,10 +68,8 @@ class Sources:
     def fetch(sources_dir: Path, remote: Optional[str]) -> None:
         """
         either clone repository or update it to origin/`branch`
-
+        :param sources_dir: local path to fetch
-        Args:
+        :param remote: remote target (from where to fetch)
-            sources_dir(Path): local path 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()
@@ -108,12 +98,8 @@ class Sources:
     def has_remotes(sources_dir: Path) -> bool:
         """
         check if there are remotes for the repository
-
+        :param sources_dir: local path to git repository
-        Args:
+        :return: True in case if there is any remote and false otherwise
-            sources_dir(Path): local path to git repository
-
-        Returns:
-            bool: True in case if there is any remote and false otherwise
         """
         remotes = Sources._check_output("git", "remote", exception=None, cwd=sources_dir, logger=Sources.logger)
         return bool(remotes)
@@ -122,9 +108,7 @@ class Sources:
     def init(sources_dir: Path) -> None:
         """
         create empty git repository at the specified path
-
+        :param sources_dir: local path to sources
-        Args:
-            sources_dir(Path): local path to sources
         """
         Sources._check_output("git", "init", "--initial-branch", Sources._branch,
                               exception=None, cwd=sources_dir, logger=Sources.logger)
@@ -133,11 +117,9 @@ class Sources:
     def load(sources_dir: Path, remote: str, patch: Optional[str]) -> None:
         """
         fetch sources from remote and apply patches
-
+        :param sources_dir: local path to fetch
-        Args:
+        :param remote: remote target (from where to fetch)
-            sources_dir(Path): local path to fetch
+        :param patch: optional patch to be applied
-            remote(str): remote target (from where to fetch)
-            patch(Optional[str]): optional patch to be applied
         """
         Sources.fetch(sources_dir, remote)
         if patch is None:
@@ -149,10 +131,8 @@ class Sources:
     def patch_apply(sources_dir: Path, patch: str) -> None:
         """
         apply patches if any
-
+        :param sources_dir: local path to directory with git sources
-        Args:
+        :param patch: patch to be applied
-            sources_dir(Path): local path to directory with git sources
-            patch(str): patch to be applied
         """
         # create patch
         Sources.logger.info("apply patch from database")
@@ -163,13 +143,9 @@ class Sources:
     def patch_create(sources_dir: Path, *pattern: str) -> str:
         """
         create patch set for the specified local path
-
+        :param sources_dir: local path to git repository
-        Args:
+        :param pattern: glob patterns
-            sources_dir(Path): local path to git repository
+        :return: patch as plain text
-            *pattern(str): glob patterns
-
-        Returns:
-            str: patch as plain text
         """
         Sources.add(sources_dir, *pattern)
         diff = Sources.diff(sources_dir)

src/ahriman/core/build_tools/task.py

@@ -35,13 +35,11 @@ from ahriman.models.repository_paths import RepositoryPaths
 class Task:
     """
     base package build task
-
+    :ivar build_logger: logger for build process
-    Attributes:
+    :ivar logger: class logger
-        build_logger(logging.Logger): logger for build process
+    :ivar package: package definitions
-        logger(logging.Logger): class logger
+    :ivar paths: repository paths instance
-        package(Package): package definitions
+    :ivar uid: uid of the repository owner user
-        paths(RepositoryPaths): repository paths instance
-        uid(int): uid of the repository owner user
     """
 
     _check_output = check_output
@@ -49,11 +47,9 @@ class Task:
     def __init__(self, package: Package, configuration: Configuration, paths: RepositoryPaths) -> None:
         """
         default constructor
-
+        :param package: package definitions
-        Args:
+        :param configuration: configuration instance
-            package(Package): package definitions
+        :param paths: repository paths instance
-            configuration(Configuration): configuration instance
-            paths(RepositoryPaths): repository paths instance
         """
         self.logger = logging.getLogger("root")
         self.build_logger = logging.getLogger("build_details")
@@ -69,12 +65,8 @@ class Task:
     def build(self, sources_path: Path) -> List[Path]:
         """
         run package build
-
+        :param sources_path: path to where sources are
-        Args:
+        :return: paths of produced packages
-            sources_path(Path): path to where sources are
-
-        Returns:
-            List[Path]: paths of produced packages
         """
         command = [self.build_command, "-r", str(self.paths.chroot)]
         command.extend(self.archbuild_flags)
@@ -99,10 +91,8 @@ class Task:
     def init(self, path: Path, database: SQLite) -> None:
         """
         fetch package from git
-
+        :param path: local path to fetch
-        Args:
+        :param database: database instance
-            path(Path): local path to fetch
-            database(SQLite): database instance
         """
         if self.paths.cache_for(self.package.base).is_dir():
             # no need to clone whole repository, just copy from cache first

src/ahriman/core/configuration.py

@@ -34,15 +34,12 @@ from ahriman.models.repository_paths import RepositoryPaths
 class Configuration(configparser.RawConfigParser):
     """
     extension for built-in configuration parser
-
+    :ivar architecture: repository architecture
-    Attributes:
+    :ivar path: path to root configuration file
-        ARCHITECTURE_SPECIFIC_SECTIONS(List[str]): (class attribute) known sections which can be architecture specific.
+    :cvar ARCHITECTURE_SPECIFIC_SECTIONS: known sections which can be architecture specific (required by dump)
-            Required by dump and merging functions
+    :cvar DEFAULT_LOG_FORMAT: default log format (in case of fallback)
-        DEFAULT_LOG_FORMAT(str): (class attribute) default log format (in case of fallback)
+    :cvar DEFAULT_LOG_LEVEL: default log level (in case of fallback)
-        DEFAULT_LOG_LEVEL(int): (class attribute) default log level (in case of fallback)
+    :cvar SYSTEM_CONFIGURATION_PATH: default system configuration path distributed by package
-        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
     """
 
     DEFAULT_LOG_FORMAT = "[%(levelname)s %(asctime)s] [%(filename)s:%(lineno)d %(funcName)s]: %(message)s"
@@ -65,30 +62,21 @@ class Configuration(configparser.RawConfigParser):
     @property
     def include(self) -> Path:
         """
-        get full path to include directory
+        :return: path to directory with configuration includes
-
-        Returns:
-            Path: path to directory with configuration includes
         """
         return self.getpath("settings", "include")
 
     @property
     def logging_path(self) -> Path:
         """
-        get full path to logging configuration
+        :return: path to logging configuration
-
-        Returns:
-            Path: path to logging configuration
         """
         return self.getpath("settings", "logging")
 
     @property
     def repository_paths(self) -> RepositoryPaths:
         """
-        construct RepositoryPaths instance based on the configuration
+        :return: repository paths instance
-
-        Returns:
-            RepositoryPaths: repository paths instance
         """
         _, architecture = self.check_loaded()
         return RepositoryPaths(self.getpath("repository", "root"), architecture)
@@ -97,14 +85,10 @@ class Configuration(configparser.RawConfigParser):
     def from_path(cls: Type[Configuration], path: Path, architecture: str, quiet: bool) -> Configuration:
         """
         constructor with full object initialization
-
+        :param path: path to root configuration file
-        Args:
+        :param architecture: repository architecture
-            path(Path): path to root configuration file
+        :param quiet: force disable any log messages
-            architecture(str): repository architecture
+        :return: configuration instance
-            quiet(bool): force disable any log messages
-
-        Returns:
-            Configuration: configuration instance
         """
         config = cls()
         config.load(path)
@@ -116,15 +100,8 @@ class Configuration(configparser.RawConfigParser):
     def __convert_list(value: str) -> List[str]:
         """
         convert string value to list of strings
-
+        :param value: string configuration value
-        Args:
+        :return: list of string from the parsed string
-            value(str): string configuration value
-
-        Returns:
-            List[str]: list of string from the parsed string
-
-        Raises:
-            ValueError: in case if option value contains unclosed quotes
         """
         def generator() -> Generator[str, None, None]:
             quote_mark = None
@@ -134,7 +111,7 @@ class Configuration(configparser.RawConfigParser):
                     quote_mark = char
                 elif char == quote_mark:  # quoted part ended, reset quotation
                     quote_mark = None
-                elif char == " " and quote_mark is None:  # found space outside the quotation, yield the word
+                elif char == " " and quote_mark is None:  # found space outside of the quotation, yield the word
                     yield word
                     word = ""
                 else:  # append character to the buffer
@@ -149,25 +126,17 @@ class Configuration(configparser.RawConfigParser):
     def section_name(section: str, suffix: str) -> str:
         """
         generate section name for sections which depends on context
-
+        :param section: section name
-        Args:
+        :param suffix: session suffix, e.g. repository architecture
-            section(str): section name
+        :return: correct section name for repository specific section
-            suffix(str): session suffix, e.g. repository architecture
-
-        Returns:
-            str: correct section name for repository specific section
         """
         return f"{section}:{suffix}"
 
     def __convert_path(self, value: str) -> Path:
         """
         convert string value to path object
-
+        :param value: string configuration value
-        Args:
+        :return: path object which represents the configuration value
-            value(str): string configuration value
-
-        Returns:
-            Path: path object which represents the configuration value
         """
         path = Path(value)
         if self.path is None or path.is_absolute():
@@ -177,12 +146,7 @@ class Configuration(configparser.RawConfigParser):
     def check_loaded(self) -> Tuple[Path, str]:
         """
         check if service was actually loaded
-
+        :return: configuration root path and architecture if loaded
-        Returns:
-            Tuple[Path, str]: configuration root path and architecture if loaded
-
-        Raises:
-            InitializeException: in case if architecture and/or path are not set
         """
         if self.path is None or self.architecture is None:
             raise InitializeException("Configuration path and/or architecture are not set")
@@ -191,9 +155,7 @@ class Configuration(configparser.RawConfigParser):
     def dump(self) -> Dict[str, Dict[str, str]]:
         """
         dump configuration to dictionary
-
+        :return: configuration dump for specific architecture
-        Returns:
-            Dict[str, Dict[str, str]]: configuration dump for specific architecture
         """
         return {
             section: dict(self[section])
@@ -210,16 +172,9 @@ class Configuration(configparser.RawConfigParser):
         """
         get type variable with fallback to old logic
         Despite the fact that it has same semantics as other get* methods, but it has different argument list
-
+        :param section: section name
-        Args:
+        :param architecture: repository architecture
-            section(str): section name
+        :return: section name and found type name
-            architecture(str): repository architecture
-
-        Returns:
-            Tuple[str, str]: section name and found type name
-
-        Raises:
-            configparser.NoSectionError: in case if no section found
         """
         group_type = self.get(section, "type", fallback=None)  # new-style logic
         if group_type is not None:
@@ -236,9 +191,7 @@ class Configuration(configparser.RawConfigParser):
     def load(self, path: Path) -> None:
         """
         fully load configuration
-
+        :param path: path to root configuration file
-        Args:
-            path(Path): path to root configuration file
         """
         if not path.is_file():  # fallback to the system file
             path = self.SYSTEM_CONFIGURATION_PATH
@@ -261,9 +214,7 @@ class Configuration(configparser.RawConfigParser):
     def load_logging(self, quiet: bool) -> None:
         """
         setup logging settings from configuration
-
+        :param quiet: force disable any log messages
-        Args:
-            quiet(bool): force disable any log messages
         """
         try:
             path = self.logging_path
@@ -278,9 +229,7 @@ class Configuration(configparser.RawConfigParser):
     def merge_sections(self, architecture: str) -> None:
         """
         merge architecture specific sections into main configuration
-
+        :param architecture: repository architecture
-        Args:
-            architecture(str): repository architecture
         """
         self.architecture = architecture
         for section in self.ARCHITECTURE_SPECIFIC_SECTIONS:
@@ -311,11 +260,9 @@ 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
-
+        :param section: section name
-        Args:
+        :param option: option name
-            section(str): section name
+        :param value: option value as string in parsable format
-            option(str): option name
-            value(Optional[str]): option value as string in parsable format
         """
         if not self.has_section(section):
             self.add_section(section)

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

@@ -24,22 +24,20 @@ 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(
+def migrate_data(result: MigrationResult, connection: Connection,
-        result: MigrationResult, connection: Connection, configuration: Configuration) -> None:
+                 configuration: Configuration, paths: RepositoryPaths) -> None:
     """
     perform data migration
-
+    :param result: result of the schema migration
-    Args:
+    :param connection: database connection
-        result(MigrationResult): result of the schema migration
+    :param configuration: configuration instance
-        connection(Connection): database connection
+    :param paths: repository paths instance
-        configuration(Configuration): configuration instance
     """
     # initial data migration
-    repository_paths = configuration.repository_paths
-
     if result.old_version <= 0:
-        migrate_package_statuses(connection, repository_paths)
+        migrate_package_statuses(connection, paths)
-        migrate_patches(connection, repository_paths)
+        migrate_patches(connection, paths)
         migrate_users_data(connection, configuration)

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

@@ -29,10 +29,8 @@ from ahriman.models.repository_paths import RepositoryPaths
 def migrate_package_statuses(connection: Connection, paths: RepositoryPaths) -> None:
     """
     perform migration for package statuses
-
+    :param connection: database connection
-    Args:
+    :param paths: repository paths instance
-        connection(Connection): database connection
-        paths(RepositoryPaths): repository paths instance
     """
     def insert_base(metadata: Package, last_status: BuildStatus) -> None:
         connection.execute(
@@ -77,3 +75,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

@@ -25,10 +25,8 @@ from ahriman.models.repository_paths import RepositoryPaths
 def migrate_patches(connection: Connection, paths: RepositoryPaths) -> None:
     """
     perform migration for patches
-
+    :param connection: database connection
-    Args:
+    :param paths: repository paths instance
-        connection(Connection): database connection
-        paths(RepositoryPaths): repository paths instance
     """
     root = paths.root / "patches"
     if not root.is_dir():
@@ -42,3 +40,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()

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

@@ -25,10 +25,8 @@ from ahriman.core.configuration import Configuration
 def migrate_users_data(connection: Connection, configuration: Configuration) -> None:
     """
     perform migration for users
-
+    :param connection: database connection
-    Args:
+    :param configuration: configuration instance
-        connection(Connection): database connection
-        configuration(Configuration): configuration instance
     """
     for section in configuration.sections():
         for option, value in configuration[section].items():
@@ -38,3 +36,5 @@ def migrate_users_data(connection: Connection, configuration: Configuration) ->
             connection.execute(
                 """insert into users (username, access, password) values (:username, :access, :password)""",
                 {"username": option.lower(), "access": access, "password": value})
+
+    connection.commit()

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

@@ -27,8 +27,6 @@ from pkgutil import iter_modules
 from sqlite3 import Connection
 from typing import List, Type
 
-from ahriman.core.configuration import Configuration
-from ahriman.core.database.data import migrate_data
 from ahriman.models.migration import Migration
 from ahriman.models.migration_result import MigrationResult
 
@@ -37,46 +35,32 @@ class Migrations:
     """
     simple migration wrapper for the sqlite
     idea comes from https://www.ash.dev/blog/simple-migration-system-in-sqlite/
-
+    :ivar connection: database connection
-    Attributes:
+    :ivar logger: class logger
-        configuration(Configuration): configuration instance
-        connection(Connection): database connection
-        logger(logging.Logger): class logger
     """
 
-    def __init__(self, connection: Connection, configuration: Configuration) -> None:
+    def __init__(self, connection: Connection) -> None:
         """
         default constructor
-
+        :param connection: database connection
-        Args:
-            connection(Connection): database connection
-            configuration(Configuration): configuration instance
         """
         self.connection = connection
-        self.configuration = configuration
         self.logger = logging.getLogger("database")
 
     @classmethod
-    def migrate(cls: Type[Migrations], connection: Connection, configuration: Configuration) -> MigrationResult:
+    def migrate(cls: Type[Migrations], connection: Connection) -> MigrationResult:
         """
         perform migrations implicitly
-
+        :param connection: database connection
-        Args:
+        :return: current schema version
-            connection(Connection): database connection
-            configuration(Configuration): configuration instance
-
-        Returns:
-            MigrationResult: current schema version
         """
-        return cls(connection, configuration).run()
+        return cls(connection).run()
 
     def migrations(self) -> List[Migration]:
         """
         extract all migrations from the current package
         idea comes from https://julienharbulot.com/python-dynamical-import.html
 
-        Returns:
-            List[Migration]: list of found migrations
         """
         migrations: List[Migration] = []
         package_dir = Path(__file__).resolve().parent
@@ -93,9 +77,7 @@ class Migrations:
     def run(self) -> MigrationResult:
         """
         perform migrations
-
+        :return: current schema version
-        Return:
-            MigrationResult: current schema version
         """
         migrations = self.migrations()
         current_version = self.user_version()
@@ -118,8 +100,6 @@ class Migrations:
                         cursor.execute(statement)
                     self.logger.info("migration %s at index %s has been applied", migration.name, migration.index)
 
-                migrate_data(result, self.connection, self.configuration)
-
                 cursor.execute(f"pragma user_version = {expected_version}")  # no support for ? placeholders
             except Exception:
                 self.logger.exception("migration failed with exception")
@@ -138,9 +118,7 @@ class Migrations:
     def user_version(self) -> int:
         """
         get schema version from sqlite database
-
+        ;return: current schema version
-        Returns:
-            int: current schema version
         """
         cursor = self.connection.execute("pragma user_version")
         current_version: int = cursor.fetchone()["user_version"]

src/ahriman/core/database/operations/auth_operations.py

@@ -33,25 +33,17 @@ class AuthOperations(Operations):
     def user_get(self, username: str) -> Optional[User]:
         """
         get user by username
-
+        :param username: username
-        Args:
+        :return: user if it was found
-            username(str): username
-
-        Returns:
-            Optional[User]: user if it was found
         """
         return next(iter(self.user_list(username, None)), None)
 
     def user_list(self, username: Optional[str], access: Optional[UserAccess]) -> List[User]:
         """
         get users by filter
-
+        :param username: optional filter by username
-        Args:
+        :param access: optional filter by role
-            username(Optional[str]): optional filter by username
+        :return: list of users who match criteria
-            access(Optional[UserAccess]): optional filter by role
-
-        Returns:
-            List[User]: list of users who match criteria
         """
         username_filter = username.lower() if username is not None else username
         access_filter = access.value if access is not None else access
@@ -72,9 +64,7 @@ class AuthOperations(Operations):
     def user_remove(self, username: str) -> None:
         """
         remove user from storage
-
+        :param username: username
-        Args:
-            username(str): username
         """
         def run(connection: Connection) -> None:
             connection.execute("""delete from users where username = :username""", {"username": username.lower()})
@@ -84,9 +74,7 @@ class AuthOperations(Operations):
     def user_update(self, user: User) -> None:
         """
         update user by username
-
+        :param user: user descriptor
-        Args:
-            user(User): user descriptor
         """
         def run(connection: Connection) -> None:
             connection.execute(

src/ahriman/core/database/operations/build_operations.py

@@ -32,9 +32,7 @@ class BuildOperations(Operations):
     def build_queue_clear(self, package_base: Optional[str]) -> None:
         """
         remove packages from build queue
-
+        :param package_base: optional filter by package base
-        Args:
-            package_base(Optional[str]): optional filter by package base
         """
         def run(connection: Connection) -> None:
             connection.execute(
@@ -49,9 +47,7 @@ class BuildOperations(Operations):
     def build_queue_get(self) -> List[Package]:
         """
         retrieve packages from build queue
-
+        :return: list of packages to be built
-        Return:
-            List[Package]: list of packages to be built
         """
         def run(connection: Connection) -> List[Package]:
             return [
@@ -64,9 +60,7 @@ class BuildOperations(Operations):
     def build_queue_insert(self, package: Package) -> None:
         """
         insert packages to build queue
-
+        :param package: package to be inserted
-        Args:
-            package(Package): package to be inserted
         """
         def run(connection: Connection) -> None:
             connection.execute(

src/ahriman/core/database/operations/operations.py

@@ -31,18 +31,14 @@ T = TypeVar("T")
 class Operations:
     """
     base operation class
-
+    :ivar logger: class logger
-    Attributes:
+    :ivar path: path to the database file
-        logger(logging.Logger): class logger
-        path(Path): path to the database file
     """
 
     def __init__(self, path: Path) -> None:
         """
         default constructor
-
+        :param path: path to the database file
-        Args:
-            path(Path): path to the database file
         """
         self.path = path
         self.logger = logging.getLogger("database")
@@ -51,13 +47,9 @@ class Operations:
     def factory(cursor: Cursor, row: Tuple[Any, ...]) -> Dict[str, Any]:
         """
         dictionary factory based on official documentation
-
+        :param cursor: cursor descriptor
-        Args:
+        :param row: fetched row
-            cursor(Cursor): cursor descriptor
+        :return: row converted to dictionary
-            row(Tuple[Any, ...]): fetched row
-
-        Returns:
-            Dict[str, Any]: row converted to dictionary
         """
         result = {}
         for index, column in enumerate(cursor.description):
@@ -67,13 +59,9 @@ class Operations:
     def with_connection(self, query: Callable[[Connection], T], commit: bool = False) -> T:
         """
         perform operation in connection
-
+        :param query: function to be called with connection
-        Args:
+        :param commit: if True commit() will be called on success
-            query(Callable[[Connection], T]): function to be called with connection
+        :return: result of the `query` call
-            commit(bool, optional): if True commit() will be called on success (Default value = False)
-
-        Returns:
-            T: result of the `query` call
         """
         with sqlite3.connect(self.path, detect_types=sqlite3.PARSE_DECLTYPES) as connection:
             connection.row_factory = self.factory

src/ahriman/core/database/operations/package_operations.py

@@ -35,10 +35,8 @@ class PackageOperations(Operations):
     def _package_remove_package_base(connection: Connection, package_base: str) -> None:
         """
         remove package base information
-
+        :param connection: database connection
-        Args:
+        :param package_base: package base name
-            connection(Connection): database connection
-            package_base(str): package base name
         """
         connection.execute("""delete from package_statuses where package_base = :package_base""",
                            {"package_base": package_base})
@@ -49,11 +47,9 @@ class PackageOperations(Operations):
     def _package_remove_packages(connection: Connection, package_base: str, current_packages: Iterable[str]) -> None:
         """
         remove packages belong to the package base
-
+        :param connection: database connection
-        Args:
+        :param package_base: package base name
-            connection(Connection): database connection
+        :param current_packages: current packages list which has to be left in database
-            package_base(str): package base name
-            current_packages(Iterable[str]): current packages list which has to be left in database
         """
         packages = [
             package
@@ -67,10 +63,8 @@ class PackageOperations(Operations):
     def _package_update_insert_base(connection: Connection, package: Package) -> None:
         """
         insert base package into table
-
+        :param connection: database connection
-        Args:
+        :param package: package properties
-            connection(Connection): database connection
-            package(Package): package properties
         """
         connection.execute(
             """
@@ -87,10 +81,8 @@ class PackageOperations(Operations):
     def _package_update_insert_packages(connection: Connection, package: Package) -> None:
         """
         insert packages into table
-
+        :param connection: database connection
-        Args:
+        :param package: package properties
-            connection(Connection): database connection
-            package(Package): package properties
         """
         package_list = []
         for name, description in package.packages.items():
@@ -116,11 +108,9 @@ class PackageOperations(Operations):
     def _package_update_insert_status(connection: Connection, package_base: str, status: BuildStatus) -> None:
         """
         insert base package status into table
-
+        :param connection: database connection
-        Args:
+        :param package_base: package base name
-            connection(Connection): database connection
+        :param status: new build status
-            package_base(str): package base name
-            status(BuildStatus): new build status
         """
         connection.execute(
             """
@@ -136,12 +126,8 @@ class PackageOperations(Operations):
     def _packages_get_select_package_bases(connection: Connection) -> Dict[str, Package]:
         """
         select package bases from the table
-
+        :param connection: database connection
-        Args:
+        :return: map of the package base to its descriptor (without packages themselves)
-            connection(Connection): database connection
-
-        Returns:
-            Dict[str, Package]: map of the package base to its descriptor (without packages themselves)
         """
         return {
             row["package_base"]: Package(row["package_base"], row["version"], row["aur_url"], {})
@@ -152,13 +138,9 @@ class PackageOperations(Operations):
     def _packages_get_select_packages(connection: Connection, packages: Dict[str, Package]) -> Dict[str, Package]:
         """
         select packages from the table
-
+        :param connection: database connection
-        Args:
+        :param packages: packages descriptor map
-            connection(Connection): database connection
+        :return: map of the package base to its descriptor including individual packages
-            packages(Dict[str, Package]): packages descriptor map
-
-        Returns:
-            Dict[str, Package]: map of the package base to its descriptor including individual packages
         """
         for row in connection.execute("""select * from packages"""):
             if row["package_base"] not in packages:
@@ -170,12 +152,8 @@ class PackageOperations(Operations):
     def _packages_get_select_statuses(connection: Connection) -> Dict[str, BuildStatus]:
         """
         select package build statuses from the table
-
+        :param connection: database connection
-        Args:
+        :return: map of the package base to its status
-            connection(Connection): database connection
-
-        Returns:
-            Dict[str, BuildStatus]: map of the package base to its status
         """
         return {
             row["package_base"]: BuildStatus.from_json({"status": row["status"], "timestamp": row["last_updated"]})
@@ -185,9 +163,7 @@ class PackageOperations(Operations):
     def package_remove(self, package_base: str) -> None:
         """
         remove package from database
-
+        :param package_base: package base name
-        Args:
-            package_base(str): package base name
         """
         def run(connection: Connection) -> None:
             self._package_remove_packages(connection, package_base, [])
@@ -198,10 +174,8 @@ class PackageOperations(Operations):
     def package_update(self, package: Package, status: BuildStatus) -> None:
         """
         update package status
-
+        :param package: package properties
-        Args:
+        :param status: new build status
-            package(Package): package properties
-            status(BuildStatus): new build status
         """
         def run(connection: Connection) -> None:
             self._package_update_insert_base(connection, package)
@@ -214,9 +188,7 @@ class PackageOperations(Operations):
     def packages_get(self) -> List[Tuple[Package, BuildStatus]]:
         """
         get package list and their build statuses from database
-
+        :return: list of package properties and their statuses
-        Return:
-            List[Tuple[Package, BuildStatus]]: list of package properties and their statuses
         """
         def run(connection: Connection) -> Generator[Tuple[Package, BuildStatus], None, None]:
             packages = self._packages_get_select_package_bases(connection)

src/ahriman/core/database/operations/patch_operations.py

@@ -31,22 +31,16 @@ class PatchOperations(Operations):
     def patches_get(self, package_base: str) -> Optional[str]:
         """
         retrieve patches for the package
-
+        :param package_base: package base to search for patches
-        Args:
+        :return: plain text patch for the package
-            package_base(str): package base to search for patches
-
-        Returns:
-            Optional[str]: plain text patch for the package
         """
         return self.patches_list(package_base).get(package_base)
 
     def patches_insert(self, package_base: str, patch: str) -> None:
         """
         insert or update patch in database
-
+        :param package_base: package base to insert
-        Args:
+        :param patch: patch content
-            package_base(str): package base to insert
-            patch(str): patch content
         """
         def run(connection: Connection) -> None:
             connection.execute(
@@ -65,12 +59,8 @@ class PatchOperations(Operations):
     def patches_list(self, package_base: Optional[str]) -> Dict[str, str]:
         """
         extract all patches
-
+        :param package_base: optional filter by package base
-        Args:
+        :return: map of package base to patch content
-            package_base(Optional[str]): optional filter by package base
-
-        Returns:
-            Dict[str, str]: map of package base to patch content
         """
         def run(connection: Connection) -> Dict[str, str]:
             return {
@@ -85,9 +75,7 @@ class PatchOperations(Operations):
     def patches_remove(self, package_base: str) -> None:
         """
         remove patch set
-
+        :param package_base: package base to clear patches
-        Args:
-            package_base(str): package base to clear patches
         """
         def run(connection: Connection) -> None:
             connection.execute(

src/ahriman/core/database/sqlite.py

@@ -23,9 +23,11 @@ import json
 import sqlite3
 
 from pathlib import Path
+from sqlite3 import Connection
 from typing import Type
 
 from ahriman.core.configuration import Configuration
+from ahriman.core.database.data import migrate_data
 from ahriman.core.database.migrations import Migrations
 from ahriman.core.database.operations.auth_operations import AuthOperations
 from ahriman.core.database.operations.build_operations import BuildOperations
@@ -42,12 +44,8 @@ class SQLite(AuthOperations, BuildOperations, PackageOperations, PatchOperations
     def load(cls: Type[SQLite], configuration: Configuration) -> SQLite:
         """
         construct instance from configuration
-
+        :param configuration: configuration instance
-        Args:
+        :return: fully initialized instance of the database
-            configuration(Configuration): configuration instance
-
-        Returns:
-            SQLite: fully initialized instance of the database
         """
         path = cls.database_path(configuration)
         database = cls(path)
@@ -58,21 +56,15 @@ class SQLite(AuthOperations, BuildOperations, PackageOperations, PatchOperations
     def database_path(configuration: Configuration) -> Path:
         """
         read database from configuration
-
+        :param configuration: configuration instance
-        Args:
+        :return: database path according to the configuration
-            configuration(Configuration): configuration instance
-
-        Returns:
-            Path: database path according to the configuration
         """
         return configuration.getpath("settings", "database")
 
     def init(self, configuration: Configuration) -> None:
         """
         perform database migrations
-
+        :param configuration: configuration instance
-        Args:
-            configuration(Configuration): configuration instance
         """
         # custom types support
         sqlite3.register_adapter(dict, json.dumps)
@@ -81,5 +73,9 @@ class SQLite(AuthOperations, BuildOperations, PackageOperations, PatchOperations
 
         paths = configuration.repository_paths
 
-        self.with_connection(lambda conn: Migrations.migrate(conn, configuration))
+        def run(connection: Connection) -> None:
+            result = Migrations.migrate(connection)
+            migrate_data(result, connection, configuration, paths)
+
+        self.with_connection(run)
         paths.chown(self.path)

src/ahriman/core/exceptions.py

@@ -29,9 +29,7 @@ class BuildFailed(RuntimeError):
     def __init__(self, package_base: str) -> None:
         """
         default constructor
-
+        :param package_base: package base raised exception
-        Args:
-            package_base(str): package base raised exception
         """
         RuntimeError.__init__(self, f"Package {package_base} build failed, check logs for details")
 
@@ -63,9 +61,7 @@ class InitializeException(RuntimeError):
     def __init__(self, details: str) -> None:
         """
         default constructor
-
+        :param details: details of the exception
-        Args:
-            details(str): details of the exception
         """
         RuntimeError.__init__(self, f"Could not load service: {details}")
 
@@ -78,9 +74,7 @@ class InvalidOption(ValueError):
     def __init__(self, value: Any) -> None:
         """
         default constructor
-
+        :param value: option value
-        Args:
-            value(Any): option value
         """
         ValueError.__init__(self, f"Invalid or unknown option value `{value}`")
 
@@ -93,10 +87,8 @@ class InvalidPath(ValueError):
     def __init__(self, path: Path, root: Path) -> None:
         """
         default constructor
-
+        :param path: path which raised an exception
-        Args:
+        :param root: repository root (i.e. ahriman home)
-            path(Path): path which raised an exception
-            root(Path): repository root (i.e. ahriman home)
         """
         ValueError.__init__(self, f"Path `{path}` does not belong to repository root `{root}`")
 
@@ -109,9 +101,7 @@ class InvalidPackageInfo(RuntimeError):
     def __init__(self, details: Any) -> None:
         """
         default constructor
-
+        :param details: error details
-        Args:
-            details(Any): error details
         """
         RuntimeError.__init__(self, f"There are errors during reading package information: `{details}`")
 
@@ -124,9 +114,7 @@ class MigrationError(RuntimeError):
     def __init__(self, details: str) -> None:
         """
         default constructor
-
+        :param details: error details
-        Args:
-            details(str): error details
         """
         RuntimeError.__init__(self, details)
 
@@ -139,9 +127,7 @@ class MissingArchitecture(ValueError):
     def __init__(self, command: str) -> None:
         """
         default constructor
-
+        :param command: command name which throws exception
-        Args:
-            command(str): command name which throws exception
         """
         ValueError.__init__(self, f"Architecture required for subcommand {command}, but missing")
 
@@ -154,9 +140,7 @@ class MultipleArchitectures(ValueError):
     def __init__(self, command: str) -> None:
         """
         default constructor
-
+        :param command: command name which throws exception
-        Args:
-            command(str): command name which throws exception
         """
         ValueError.__init__(self, f"Multiple architectures are not supported by subcommand {command}")
 
@@ -181,9 +165,7 @@ class SuccessFailed(ValueError):
     def __init__(self, package_base: str) -> None:
         """
         default constructor
-
+        :param package_base: package base name
-        Args:
-            package_base(str): package base name
         """
         ValueError.__init__(self, f"Package base {package_base} had status failed, but new status is success")
 
@@ -208,9 +190,7 @@ class UnknownPackage(ValueError):
     def __init__(self, package_base: str) -> None:
         """
         default constructor
-
+        :param package_base: package base name
-        Args:
-            package_base(str): package base name
         """
         ValueError.__init__(self, f"Package base {package_base} is unknown")
 
@@ -223,10 +203,8 @@ class UnsafeRun(RuntimeError):
     def __init__(self, current_uid: int, root_uid: int) -> None:
         """
         default constructor
-
+        :param current_uid: current user ID
-        Args:
+        :param root_uid: ID of the owner of root directory
-            current_uid(int): current user ID
-            root_uid(int): ID of the owner of root directory
         """
         RuntimeError.__init__(self, f"Current UID {current_uid} differs from root owner {root_uid}. "
                                     f"Note that for the most actions it is unsafe to run application as different user."

src/ahriman/core/formatters/aur_printer.py

@@ -28,17 +28,13 @@ from ahriman.models.property import Property
 class AurPrinter(StringPrinter):
     """
     print content of the AUR package
-
+    :ivar package: AUR package description
-    Attributes:
-        package(AURPackage): AUR package description
     """
 
     def __init__(self, package: AURPackage) -> None:
         """
         default constructor
-
+        :param package: AUR package description
-        Args:
-            package(AURPackage): AUR package description
         """
         StringPrinter.__init__(self, f"{package.name} {package.version} ({package.num_votes})")
         self.package = package
@@ -46,9 +42,7 @@ class AurPrinter(StringPrinter):
     def properties(self) -> List[Property]:
         """
         convert content into printable data
-
+        :return: list of content properties
-        Returns:
-            List[Property]: list of content properties
         """
         return [
             Property("Package base", self.package.package_base),

src/ahriman/core/formatters/build_printer.py

@@ -29,11 +29,9 @@ class BuildPrinter(StringPrinter):
     def __init__(self, package: Package, is_success: bool, use_utf: bool) -> None:
         """
         default constructor
-
+        :param package: built package
-        Args:
+        :param is_success: True in case if build has success status and False otherwise
-            package(Package): built package
+        :param use_utf: use utf instead of normal symbols
-            is_success(bool): True in case if build has success status and False otherwise
-            use_utf(bool): use utf instead of normal symbols
         """
         StringPrinter.__init__(self, f"{self.sign(is_success, use_utf)} {package.base}")
 
@@ -41,13 +39,9 @@ class BuildPrinter(StringPrinter):
     def sign(is_success: bool, use_utf: bool) -> str:
         """
         generate sign according to settings
-
+        :param use_utf: use utf instead of normal symbols
-        Args:
+        :param is_success: True in case if build has success status and False otherwise
-            is_success(bool): True in case if build has success status and False otherwise
+        :return: sign symbol according to current settings
-            use_utf(bool): use utf instead of normal symbols
-
-        Returns:
-            str: sign symbol according to current settings
         """
         if is_success:
             return "[✔]" if use_utf else "[x]"

src/ahriman/core/formatters/configuration_printer.py

@@ -26,18 +26,14 @@ from ahriman.models.property import Property
 class ConfigurationPrinter(StringPrinter):
     """
     print content of the configuration section
-
+    :ivar values: configuration values dictionary
-    Attributes:
-        values(Dict[str, str]): configuration values dictionary
     """
 
     def __init__(self, section: str, values: Dict[str, str]) -> None:
         """
         default constructor
-
+        :param section: section name
-        Args:
+        :param values: configuration values dictionary
-            section(str): section name
-            values(Dict[str, str]): configuration values dictionary
         """
         StringPrinter.__init__(self, f"[{section}]")
         self.values = values
@@ -45,9 +41,7 @@ class ConfigurationPrinter(StringPrinter):
     def properties(self) -> List[Property]:
         """
         convert content into printable data
-
+        :return: list of content properties
-        Returns:
-            List[Property]: list of content properties
         """
         return [
             Property(key, value, is_required=True)

src/ahriman/core/formatters/package_printer.py

@@ -28,19 +28,15 @@ from ahriman.models.property import Property
 class PackagePrinter(StringPrinter):
     """
     print content of the internal package object
-
+    :ivar package: package description
-    Attributes:
+    :ivar status: build status
-        package(Package): package description
-        status(BuildStatus): build status
     """
 
     def __init__(self, package: Package, status: BuildStatus) -> None:
         """
         default constructor
-
+        :param package: package description
-        Args:
+        :param status: build status
-            package(Package): package description
-            status(BuildStatus): build status
         """
         StringPrinter.__init__(self, package.pretty_print())
         self.package = package
@@ -49,9 +45,7 @@ class PackagePrinter(StringPrinter):
     def properties(self) -> List[Property]:
         """
         convert content into printable data
-
+        :return: list of content properties
-        Returns:
-            List[Property]: list of content properties
         """
         return [
             Property("Version", self.package.version, is_required=True),

src/ahriman/core/formatters/printer.py

@@ -30,12 +30,9 @@ class Printer:
     def print(self, verbose: bool, log_fn: Callable[[str], None] = print, separator: str = ": ") -> None:
         """
         print content
-
+        :param verbose: print all fields
-        Args:
+        :param log_fn: logger function to log data
-            verbose(bool): print all fields
+        :param separator: separator for property name and property value
-            log_fn(Callable[[str]): logger function to log data
-            None]:  (Default value = print)
-            separator(str, optional): separator for property name and property value (Default value = ": ")
         """
         if (title := self.title()) is not None:
             log_fn(title)
@@ -47,16 +44,12 @@ class Printer:
     def properties(self) -> List[Property]:  # pylint: disable=no-self-use
         """
         convert content into printable data
-
+        :return: list of content properties
-        Returns:
-            List[Property]: list of content properties
         """
         return []
 
     def title(self) -> Optional[str]:
         """
         generate entry title from content
-
+        :return: content title if it can be generated and None otherwise
-        Returns:
-            Optional[str]: content title if it can be generated and None otherwise
         """

src/ahriman/core/formatters/status_printer.py

@@ -29,8 +29,6 @@ class StatusPrinter(StringPrinter):
     def __init__(self, status: BuildStatus) -> None:
         """
         default constructor
-
+        :param status: build status
-        Args:
-            status(BuildStatus): build status
         """
         StringPrinter.__init__(self, status.pretty_print())

src/ahriman/core/formatters/string_printer.py

@@ -30,17 +30,13 @@ class StringPrinter(Printer):
     def __init__(self, content: str) -> None:
         """
         default constructor
-
+        :param content: any content string
-        Args:
-            content(str): any content string
         """
         self.content = content
 
     def title(self) -> Optional[str]:
         """
         generate entry title from content
-
+        :return: content title if it can be generated and None otherwise
-        Returns:
-            Optional[str]: content title if it can be generated and None otherwise
         """
         return self.content

src/ahriman/core/formatters/update_printer.py

@@ -27,19 +27,15 @@ from ahriman.models.property import Property
 class UpdatePrinter(StringPrinter):
     """
     print content of the package update
-
+    :ivar package: remote (new) package object
-    Attributes:
+    :ivar local_version: local version of the package if any
-        package(Package): remote (new) package object
-        local_version(Optional[str]): local version of the package if any
     """
 
     def __init__(self, remote: Package, local_version: Optional[str]) -> None:
         """
         default constructor
-
+        :param remote: remote (new) package object
-        Args:
+        :param local_version: local version of the package if any
-            remote(Package): remote (new) package object
-            local_version(Optional[str]): local version of the package if any
         """
         StringPrinter.__init__(self, remote.base)
         self.package = remote
@@ -48,8 +44,6 @@ class UpdatePrinter(StringPrinter):
     def properties(self) -> List[Property]:
         """
         convert content into printable data
-
+        :return: list of content properties
-        Returns:
-            List[Property]: list of content properties
         """
         return [Property(self.local_version, self.package.version, is_required=True)]

src/ahriman/core/formatters/user_printer.py

@@ -27,17 +27,13 @@ from ahriman.models.user import User
 class UserPrinter(StringPrinter):
     """
     print properties of user
-
+    :ivar user: stored user
-    Attributes:
-        user(User): stored user
     """
 
     def __init__(self, user: User) -> None:
         """
         default constructor
-
+        :param user: user to print
-        Args:
-            user(User): user to print
         """
         StringPrinter.__init__(self, user.username)
         self.user = user
@@ -45,8 +41,6 @@ class UserPrinter(StringPrinter):
     def properties(self) -> List[Property]:
         """
         convert content into printable data
-
+        :return: list of content properties
-        Returns:
-            List[Property]: list of content properties
         """
         return [Property("role", self.user.access.value, is_required=True)]

src/ahriman/core/report/console.py

@@ -29,19 +29,15 @@ from ahriman.models.result import Result
 class Console(Report):
     """
     html report generator
-
+    :ivar use_utf: print utf8 symbols instead of ASCII
-    Attributes:
-        use_utf(bool): print utf8 symbols instead of ASCII
     """
 
     def __init__(self, architecture: str, configuration: Configuration, section: str) -> None:
         """
         default constructor
-
+        :param architecture: repository architecture
-        Args:
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param section: settings section name
-            configuration(Configuration): configuration instance
-            section(str): settings section name
         """
         Report.__init__(self, architecture, configuration)
         self.use_utf = configuration.getboolean(section, "use_utf", fallback=True)
@@ -49,10 +45,8 @@ class Console(Report):
     def generate(self, packages: Iterable[Package], result: Result) -> None:
         """
         generate report for the specified packages
-
+        :param packages: list of packages to generate report
-        Args:
+        :param result: build result
-            packages(Iterable[Package]): list of packages to generate report
-            result(Result): build result
         """
         for package in result.success:
             BuildPrinter(package, is_success=True, use_utf=self.use_utf).print(verbose=True)

src/ahriman/core/report/email.py

@@ -36,28 +36,24 @@ from ahriman.models.smtp_ssl_settings import SmtpSSLSettings
 class Email(Report, JinjaTemplate):
     """
     email report generator
-
+    :ivar full_template_path: path to template for full package list
-    Attributes:
+    :ivar host: SMTP host to connect
-        full_template_path(Path): path to template for full package list
+    :ivar no_empty_report: skip empty report generation
-        host(str): SMTP host to connect
+    :ivar password: password to authenticate via SMTP
-        no_empty_report(bool): skip empty report generation
+    :ivar port: SMTP port to connect
-        password(Optional[str]): password to authenticate via SMTP
+    :ivar receivers: list of receivers emails
-        port(int): SMTP port to connect
+    :ivar sender: sender email address
-        receivers(List[str]): list of receivers emails
+    :ivar ssl: SSL mode for SMTP connection
-        sender(str): sender email address
+    :ivar template_path: path to template for built packages
-        ssl(SmtpSSLSettings): SSL mode for SMTP connection
+    :ivar user: username to authenticate via SMTP
-        template_path(Path): path to template for built packages
-        user(Optional[str]): username to authenticate via SMTP
     """
 
     def __init__(self, architecture: str, configuration: Configuration, section: str) -> None:
         """
         default constructor
-
+        :param architecture: repository architecture
-        Args:
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param section: settings section name
-            configuration(Configuration): configuration instance
-            section(str): settings section name
         """
         Report.__init__(self, architecture, configuration)
         JinjaTemplate.__init__(self, section, configuration)
@@ -78,10 +74,8 @@ class Email(Report, JinjaTemplate):
     def _send(self, text: str, attachment: Dict[str, str]) -> None:
         """
         send email callback
-
+        :param text: email body text
-        Args:
+        :param attachment: map of attachment filename to attachment content
-            text(str): email body text
-            attachment(Dict[str, str]): map of attachment filename to attachment content
         """
         message = MIMEMultipart()
         message["From"] = self.sender
@@ -108,10 +102,8 @@ class Email(Report, JinjaTemplate):
     def generate(self, packages: Iterable[Package], result: Result) -> None:
         """
         generate report for the specified packages
-
+        :param packages: list of packages to generate report
-        Args:
+        :param result: build result
-            packages(Iterable[Package]): list of packages to generate report
-            result(Result): build result
         """
         if self.no_empty_report and not result.success:
             return

src/ahriman/core/report/html.py

@@ -29,20 +29,16 @@ from ahriman.models.result import Result
 class HTML(Report, JinjaTemplate):
     """
     html report generator
-
+    :ivar report_path: output path to html report
-    Attributes:
+    :ivar template_path: path to template for full package list
-        report_path(Path): output path to html report
-        template_path(Path): path to template for full package list
     """
 
     def __init__(self, architecture: str, configuration: Configuration, section: str) -> None:
         """
         default constructor
-
+        :param architecture: repository architecture
-        Args:
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param section: settings section name
-            configuration(Configuration): configuration instance
-            section(str): settings section name
         """
         Report.__init__(self, architecture, configuration)
         JinjaTemplate.__init__(self, section, configuration)
@@ -53,10 +49,8 @@ class HTML(Report, JinjaTemplate):
     def generate(self, packages: Iterable[Package], result: Result) -> None:
         """
         generate report for the specified packages
-
+        :param packages: list of packages to generate report
-        Args:
+        :param result: build result
-            packages(Iterable[Package]): list of packages to generate report
-            result(Result): build result
         """
         html = self.make_html(Result(success=packages), self.template_path)
         self.report_path.write_text(html)

src/ahriman/core/report/jinja_template.py

@@ -35,41 +35,38 @@ class JinjaTemplate:
 
     It uses jinja2 templates for report generation, the following variables are allowed:
 
-        * homepage - link to homepage, string, optional
+        homepage - link to homepage, string, optional
-        * link_path - prefix fo packages to download, string, required
+        link_path - prefix fo packages to download, string, required
-        * has_package_signed - True in case if package sign enabled, False otherwise, required
+        has_package_signed - True in case if package sign enabled, False otherwise, required
-        * has_repo_signed - True in case if repository database sign enabled, False otherwise, required
+        has_repo_signed - True in case if repository database sign enabled, False otherwise, required
-        * packages - sorted list of packages properties, required
+        packages - sorted list of packages properties, required
-            * architecture, string
+                   * architecture, string
-            * archive_size, pretty printed size, string
+                   * archive_size, pretty printed size, string
-            * build_date, pretty printed datetime, string
+                   * build_date, pretty printed datetime, string
-            * depends, sorted list of strings
+                   * depends, sorted list of strings
-            * description, string
+                   * description, string
-            * filename, string,
+                   * filename, string,
-            * groups, sorted list of strings
+                   * groups, sorted list of strings
-            * installed_size, pretty printed datetime, string
+                   * installed_size, pretty printed datetime, string
-            * licenses, sorted list of strings
+                   * licenses, sorted list of strings
-            * name, string
+                   * name, string
-            * url, string
+                   * url, string
-            * version, string
+                   * version, string
-        * pgp_key - default PGP key ID, string, optional
+        pgp_key - default PGP key ID, string, optional
-        * repository - repository name, string, required
+        repository - repository name, string, required
 
-    Attributes:
+    :ivar homepage: homepage link if any (for footer)
-        homepage(Optional[str]): homepage link if any (for footer)
+    :ivar link_path: prefix fo packages to download
-        link_path(str): prefix fo packages to download
+    :ivar name: repository name
-        name(str): repository name
+    :ivar default_pgp_key: default PGP key
-        default_pgp_key(Optional[str]): default PGP key
+    :ivar sign_targets: targets to sign enabled in configuration
-        sign_targets(Set[SignSettings]): targets to sign enabled in configuration
     """
 
     def __init__(self, section: str, configuration: Configuration) -> None:
         """
         default constructor
-
+        :param section: settings section name
-        Args:
+        :param configuration: configuration instance
-            section(str): settings section name
-            configuration(Configuration): configuration instance
         """
         self.link_path = configuration.get(section, "link_path")
 
@@ -82,10 +79,8 @@ class JinjaTemplate:
     def make_html(self, result: Result, template_path: Path) -> str:
         """
         generate report for the specified packages
-
+        :param result: build result
-        Args:
+        :param template_path: path to jinja template
-            result(Result): build result
-            template_path(Path): path to jinja template
         """
         # idea comes from https://stackoverflow.com/a/38642558
         loader = jinja2.FileSystemLoader(searchpath=template_path.parent)

src/ahriman/core/report/report.py

@@ -33,20 +33,16 @@ from ahriman.models.result import Result
 class Report:
     """
     base report generator
-
+    :ivar architecture: repository architecture
-    Attributes:
+    :ivar configuration: configuration instance
-        architecture(str): repository architecture
+    :ivar logger: class logger
-        configuration(Configuration): configuration instance
-        logger(logging.Logger): class logger
     """
 
     def __init__(self, architecture: str, configuration: Configuration) -> None:
         """
         default constructor
-
+        :param architecture: repository architecture
-        Args:
+        :param configuration: configuration instance
-            architecture(str): repository architecture
-            configuration(Configuration): configuration instance
         """
         self.logger = logging.getLogger("root")
         self.architecture = architecture
@@ -56,14 +52,10 @@ class Report:
     def load(cls: Type[Report], architecture: str, configuration: Configuration, target: str) -> Report:
         """
         load client from settings
-
+        :param architecture: repository architecture
-        Args:
+        :param configuration: configuration instance
-            architecture(str): repository architecture
+        :param target: target to generate report aka section name (e.g. html)
-            configuration(Configuration): configuration instance
+        :return: client according to current settings
-            target(str): target to generate report aka section name (e.g. html)
-
-        Returns:
-            Report: client according to current settings
         """
         section, provider_name = configuration.gettype(target, architecture)
         provider = ReportSettings.from_option(provider_name)
@@ -84,22 +76,15 @@ class Report:
     def generate(self, packages: Iterable[Package], result: Result) -> None:
         """
         generate report for the specified packages
-
+        :param packages: list of packages to generate report
-        Args:
+        :param result: build result
-            packages(Iterable[Package]): list of packages to generate report
-            result(Result): build result
         """
 
     def run(self, packages: Iterable[Package], result: Result) -> None:
         """
         run report generation
-
+        :param packages: list of packages to generate report
-        Args:
+        :param result: build result
-            packages(Iterable[Package]): list of packages to generate report
-            result(Result): build result
-
-        Raises:
-            ReportFailed: in case of any report unmatched exception
         """
         try:
             self.generate(packages, result)