Skip to main content

Automate quality-check of Python package with bundled utils

Project description

audit python3.8 mit black

Automate quality-check of Python package with bundled utils

usage: pyaud [-h] [-c] [-d] [-s] [--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
  --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 ````
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``

Project details

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyaud-1.0.0.tar.gz (16.8 kB view hashes)

Uploaded Source

Built Distribution

pyaud-1.0.0-py3-none-any.whl (18.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page