pyvelocity

Automates task to check configurations about Python project to follow best practices to increase development velocity.

Attention

The development status of this package is Beta now. It may not be able to keep backward compatibility. Be careful to use, especially for CI.

Check content

• line-length
• using-py-project-toml

line-length

Checks if following settings are same:

• docformatter:
  • wrap-descriptions
  • wrap-summaries
• isort: line_length
• Black: line-length
• flake8: max-line-length
• Pylint: format: max-line-length

using-py-project-toml

Checks if use pyproject.toml.

Quickstart

1. Install

pip install pyvelocity

2. Run command

Run following command at the directory which pyproject.toml and setup.cfg exists.

pyvelocity

How do I...

Ignore specific check?

For examble, if you want to ignore the check: line-length, add following content into pyproject.toml:

[tool.pyvelocity]
filter = [
  "line-length"
]

Credits

This package was created with Cookiecutter and the yukihiko-shinoda/cookiecutter-pypackage project template.