Skip to main content

Plugin package for Pyaud

Project description

License PyPI Build CodeQL pre-commit.ci status codecov.io readthedocs.org python3.8 Black isort docformatter pylint Security Status Known Vulnerabilities pyaud-plugins

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`

Project details


Download files

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

Source Distribution

pyaud_plugins-0.17.2.tar.gz (13.1 kB view details)

Uploaded Source

Built Distribution

pyaud_plugins-0.17.2-py3-none-any.whl (15.0 kB view details)

Uploaded Python 3

File details

Details for the file pyaud_plugins-0.17.2.tar.gz.

File metadata

  • Download URL: pyaud_plugins-0.17.2.tar.gz
  • Upload date:
  • Size: 13.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.8.13 Darwin/23.1.0

File hashes

Hashes for pyaud_plugins-0.17.2.tar.gz
Algorithm Hash digest
SHA256 af2d26cf37684a810b1242141a53e8e360b45ba6ca89475de3fa09a37b00cd4f
MD5 4aa02b50b632a9ddeb2764898b3d6eda
BLAKE2b-256 7b7a4a56f0e36b8117aeb38c262834a2e69a0b23988835f407454f726def3b54

See more details on using hashes here.

File details

Details for the file pyaud_plugins-0.17.2-py3-none-any.whl.

File metadata

  • Download URL: pyaud_plugins-0.17.2-py3-none-any.whl
  • Upload date:
  • Size: 15.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.8.13 Darwin/23.1.0

File hashes

Hashes for pyaud_plugins-0.17.2-py3-none-any.whl
Algorithm Hash digest
SHA256 289652d918e82ab8d3ffc9d672e76fb7fa4b92de65d20aa6dba2b61d25e8d514
MD5 7018a8b438a90a183a6d47def05fab40
BLAKE2b-256 50a6ccfd8b41f1b1c397d6c61406a007059bd86a005c3cf20c7f6169fbb9f3dc

See more details on using hashes here.

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