pyaud-plugins 0.20.0

Plugin package for Pyaud

Plugin package for Pyaud

Dependencies

pip install pyaud

Install

pip install pyaud-plugins

Development

poetry install

Usage

See pyaud

Plugins

pyaud will automatically load this package on search for all packages prefixed with “pyaud_”

For writing plugins see docs

This package contains the following plugins on running pyaud modules

about-tests     -- Check tests README is up-to-date
audit           -- Read from [audit] key in config
change-logged   -- Check commits with loggable tags are added to CHANGELOG
commit-policy   -- Test commit policy is up to date
const           -- Check code for repeat use of strings
coverage        -- Run package unit-tests with `pytest` and `coverage`
docs            -- Compile package documentation with `Sphinx`
doctest         -- Run `doctest` on all code examples
doctest-package -- Run `doctest` on package
doctest-readme  -- Run `doctest` on Python code-blocks in README
files           -- Audit project data files
format          -- Audit code with `Black`
format-docs     -- Format docstrings with `docformatter`
format-str      -- Format f-strings with `flynt`
imports         -- Audit imports with `isort`
lint            -- Lint code with `pylint`
modules         -- Display all available plugins and their documentation
params          -- Check docstring params match function signatures
readme-help     -- Test help documented in README is up to date
sort-pyproject  -- Sort pyproject.toml file with `toml-sort`
test            -- Run all tests
tests           -- Run the package unit-tests with `pytest`
toc             -- Audit docs/<NAME>.rst toc-file
typecheck       -- Typecheck code with `mypy`
unused          -- Audit unused code with `vulture`
whitelist       -- Check whitelist.py file with `vulture`