pyaud-plugins
=============
.. image:: https://img.shields.io/badge/License-MIT-yellow.svg
:target: https://opensource.org/licenses/MIT
:alt: License
.. image:: https://img.shields.io/pypi/v/pyaud-plugins
:target: https://pypi.org/project/pyaud-plugins/
:alt: PyPI
.. image:: https://github.com/jshwi/pyaud-plugins/actions/workflows/build.yaml/badge.svg
:target: https://github.com/jshwi/pyaud-plugins/actions/workflows/build.yaml
:alt: Build
.. image:: https://github.com/jshwi/pyaud-plugins/actions/workflows/codeql-analysis.yml/badge.svg
:target: https://github.com/jshwi/pyaud-plugins/actions/workflows/codeql-analysis.yml
:alt: CodeQL
.. image:: https://results.pre-commit.ci/badge/github/jshwi/pyaud-plugins/master.svg
:target: https://results.pre-commit.ci/latest/github/jshwi/pyaud-plugins/master
:alt: pre-commit.ci status
.. image:: https://codecov.io/gh/jshwi/pyaud-plugins/branch/master/graph/badge.svg
:target: https://codecov.io/gh/jshwi/pyaud-plugins
:alt: codecov.io
.. image:: https://readthedocs.org/projects/pyaud-plugins/badge/?version=latest
:target: https://pyaud-plugins.readthedocs.io/en/latest/?badge=latest
:alt: readthedocs.org
.. image:: https://img.shields.io/badge/python-3.8-blue.svg
:target: https://www.python.org/downloads/release/python-380
:alt: python3.8
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Black
.. image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336
:target: https://pycqa.github.io/isort/
:alt: isort
.. image:: https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg
:target: https://github.com/PyCQA/docformatter
:alt: docformatter
.. image:: https://img.shields.io/badge/linting-pylint-yellowgreen
:target: https://github.com/PyCQA/pylint
:alt: pylint
.. image:: https://img.shields.io/badge/security-bandit-yellow.svg
:target: https://github.com/PyCQA/bandit
:alt: Security Status
.. image:: https://snyk.io/test/github/jshwi/pyaud-plugins/badge.svg
:target: https://snyk.io/test/github/jshwi/pyaud-plugins/badge.svg
:alt: Known Vulnerabilities
.. image:: https://snyk.io/advisor/python/pyaud-plugins/badge.svg
:target: https://snyk.io/advisor/python/pyaud-plugins
:alt: pyaud-plugins
Plugin package for Pyaud
------------------------
Dependencies
------------
``pip install pyaud``
Install
-------
``pip install pyaud-plugins``
Development
-----------
``poetry install``
Usage
-----
See `pyaud <https://github.com/jshwi/pyaud#pyaud>`_
Plugins
-------
``pyaud`` will automatically load this package on search for all packages prefixed with `"pyaud_"`
For writing plugins see `docs <https://jshwi.github.io/pyaud/pyaud.html#pyaud-plugins>`_
This package contains the following plugins on running `pyaud modules`
.. code-block:: console
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
copyright-year -- Test copyright year is up to date
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`
Raw data
{
"_id": null,
"home_page": "https://pypi.org/project/pyaud-plugins/",
"name": "pyaud-plugins",
"maintainer": "jshwi",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "stephen@jshwisolutions.com",
"keywords": "audit,ci,plugins,pyaud,python",
"author": "jshwi",
"author_email": "stephen@jshwisolutions.com",
"download_url": "https://files.pythonhosted.org/packages/44/35/d92c810bff1b2e640c14736ac5912b5f316b3d34e7f66949a1c4bacbb242/pyaud_plugins-0.22.0.tar.gz",
"platform": null,
"description": "pyaud-plugins\n=============\n.. image:: https://img.shields.io/badge/License-MIT-yellow.svg\n :target: https://opensource.org/licenses/MIT\n :alt: License\n.. image:: https://img.shields.io/pypi/v/pyaud-plugins\n :target: https://pypi.org/project/pyaud-plugins/\n :alt: PyPI\n.. image:: https://github.com/jshwi/pyaud-plugins/actions/workflows/build.yaml/badge.svg\n :target: https://github.com/jshwi/pyaud-plugins/actions/workflows/build.yaml\n :alt: Build\n.. image:: https://github.com/jshwi/pyaud-plugins/actions/workflows/codeql-analysis.yml/badge.svg\n :target: https://github.com/jshwi/pyaud-plugins/actions/workflows/codeql-analysis.yml\n :alt: CodeQL\n.. image:: https://results.pre-commit.ci/badge/github/jshwi/pyaud-plugins/master.svg\n :target: https://results.pre-commit.ci/latest/github/jshwi/pyaud-plugins/master\n :alt: pre-commit.ci status\n.. image:: https://codecov.io/gh/jshwi/pyaud-plugins/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/jshwi/pyaud-plugins\n :alt: codecov.io\n.. image:: https://readthedocs.org/projects/pyaud-plugins/badge/?version=latest\n :target: https://pyaud-plugins.readthedocs.io/en/latest/?badge=latest\n :alt: readthedocs.org\n.. image:: https://img.shields.io/badge/python-3.8-blue.svg\n :target: https://www.python.org/downloads/release/python-380\n :alt: python3.8\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Black\n.. image:: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336\n :target: https://pycqa.github.io/isort/\n :alt: isort\n.. image:: https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg\n :target: https://github.com/PyCQA/docformatter\n :alt: docformatter\n.. image:: https://img.shields.io/badge/linting-pylint-yellowgreen\n :target: https://github.com/PyCQA/pylint\n :alt: pylint\n.. image:: https://img.shields.io/badge/security-bandit-yellow.svg\n :target: https://github.com/PyCQA/bandit\n :alt: Security Status\n.. image:: https://snyk.io/test/github/jshwi/pyaud-plugins/badge.svg\n :target: https://snyk.io/test/github/jshwi/pyaud-plugins/badge.svg\n :alt: Known Vulnerabilities\n.. image:: https://snyk.io/advisor/python/pyaud-plugins/badge.svg\n :target: https://snyk.io/advisor/python/pyaud-plugins\n :alt: pyaud-plugins\n\nPlugin package for Pyaud\n------------------------\n\nDependencies\n------------\n\n``pip install pyaud``\n\nInstall\n-------\n\n``pip install pyaud-plugins``\n\nDevelopment\n-----------\n\n``poetry install``\n\nUsage\n-----\n\nSee `pyaud <https://github.com/jshwi/pyaud#pyaud>`_\n\nPlugins\n-------\n\n``pyaud`` will automatically load this package on search for all packages prefixed with `\"pyaud_\"`\n\nFor writing plugins see `docs <https://jshwi.github.io/pyaud/pyaud.html#pyaud-plugins>`_\n\nThis package contains the following plugins on running `pyaud modules`\n\n.. code-block:: console\n\n about-tests -- Check tests README is up-to-date\n audit -- Read from [audit] key in config\n change-logged -- Check commits with loggable tags are added to CHANGELOG\n commit-policy -- Test commit policy is up to date\n const -- Check code for repeat use of strings\n copyright-year -- Test copyright year is up to date\n coverage -- Run package unit-tests with `pytest` and `coverage`\n docs -- Compile package documentation with `Sphinx`\n doctest -- Run `doctest` on all code examples\n doctest-package -- Run `doctest` on package\n doctest-readme -- Run `doctest` on Python code-blocks in README\n files -- Audit project data files\n format -- Audit code with `Black`\n format-docs -- Format docstrings with `docformatter`\n format-str -- Format f-strings with `flynt`\n imports -- Audit imports with `isort`\n lint -- Lint code with `pylint`\n modules -- Display all available plugins and their documentation\n params -- Check docstring params match function signatures\n readme-help -- Test help documented in README is up to date\n sort-pyproject -- Sort pyproject.toml file with `toml-sort`\n test -- Run all tests\n tests -- Run the package unit-tests with `pytest`\n toc -- Audit docs/<NAME>.rst toc-file\n typecheck -- Typecheck code with `mypy`\n unused -- Audit unused code with `vulture`\n whitelist -- Check whitelist.py file with `vulture`\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Plugin package for Pyaud",
"version": "0.22.0",
"project_urls": {
"Documentation": "https://pyaud-plugins.readthedocs.io/en/latest",
"Homepage": "https://pypi.org/project/pyaud-plugins/",
"Repository": "https://github.com/jshwi/pyaud-plugins"
},
"split_keywords": [
"audit",
"ci",
"plugins",
"pyaud",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0d5236aeb2b60e7a01b0fdb28edd508962ed599e407cc4b395c04e19d77dcb54",
"md5": "512ed2f2ee69985cb70b39929a69282b",
"sha256": "fe589075df2f3e6b99e39c101ef61ec96b1dddb96f71c4cc867d8e4a120d0189"
},
"downloads": -1,
"filename": "pyaud_plugins-0.22.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "512ed2f2ee69985cb70b39929a69282b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 15416,
"upload_time": "2024-01-31T19:07:14",
"upload_time_iso_8601": "2024-01-31T19:07:14.999523Z",
"url": "https://files.pythonhosted.org/packages/0d/52/36aeb2b60e7a01b0fdb28edd508962ed599e407cc4b395c04e19d77dcb54/pyaud_plugins-0.22.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4435d92c810bff1b2e640c14736ac5912b5f316b3d34e7f66949a1c4bacbb242",
"md5": "d78cfc4f7eed75cbcd67e66782e52d02",
"sha256": "4b3c342338e2b88e75f3fff56efafda0b9a21ad92f4b95dd875102d8ccc033b0"
},
"downloads": -1,
"filename": "pyaud_plugins-0.22.0.tar.gz",
"has_sig": false,
"md5_digest": "d78cfc4f7eed75cbcd67e66782e52d02",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 13527,
"upload_time": "2024-01-31T19:07:16",
"upload_time_iso_8601": "2024-01-31T19:07:16.659462Z",
"url": "https://files.pythonhosted.org/packages/44/35/d92c810bff1b2e640c14736ac5912b5f316b3d34e7f66949a1c4bacbb242/pyaud_plugins-0.22.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-31 19:07:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jshwi",
"github_project": "pyaud-plugins",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pyaud-plugins"
}
JSON
