pyaud 1.2.1

Automate quality-check of Python package with bundled utils

Automate quality-check of Python package with bundled utils

usage: pyaud [-h] [-c] [-d] [-s] [-v] [--path PATH] MODULE

positional arguments:
  MODULE          choice of module: ``modules`` to list all options

optional arguments:
  -h, --help      show this help message and exit
  -c, --clean     clean unversioned files prior to any process
  -d, --deploy    include test and docs deployment after audit
  -s, --suppress  continue without stopping for errors
  -v, --verbose   incrementally increase logging verbosity
  --path PATH     set alternative path to present working dir
---------------------------------------------------------------------------

audit                   Run all checks
clean                   Remove all unversioned files unless excluded
coverage                Run ``pytest`` with ``coverage``
deploy                  Deploy code coverage and documentation
deploy-cov              Deploy code coverage to ``codecov.io``
deploy-docs             Deploy ``Sphinx`` docs to ``gh-pages``
docs                    Compile documentation with ``Sphinx``
files                   Run ``requirements``, ``toc``, and ``whitelist``
format                  Format all Python project files with ``Black``
lint                    Show possible corrections with ``pylint``
requirements            Create requirements.txt from Pipfile.lock
tests                   Run unittests with ``pytest``
toc                     Update docs/<PACKAGENAME>.rst
typecheck               Inspect files for type errors with ``mypy``
unused                  Inspect files for unused code with ``vulture``
whitelist               Update ``vulture`` whitelist.py