su6 0.3.0

Python cli tool to use tools for some common code quality checks (opinionated)

su6-checker

---

su6 (6 is pronounced as '/zɛs/' in Dutch, so 'su6' is basically 'success')
This package will hopefully help achieve that!

Table of Contents

• Installation
• Usage
• License
• Changelog

Installation

# quick install with all possible checkers:
pip install su6[all]
# or pick and choose checkers:
pip install [black,bandit,pydocstyle]

Note: this package does not work well with pipx, since a lot of the tools need to be in the same (virtual) environment of your code, in order to do proper analysis.

The following checkers are supported:

ruff

• install: pip install su6[ruff]
• use: su6 ruff
• functionality: linter
• pypi: ruff

black

• install: pip install su6[black]
• use: su6 black, su6 black --fix
• functionality: formatter
• pypi: black

mypy

• install: pip install su6[mypy]
• use: su6 mypy
• functionality: static type checker
• pypi: mypy

bandit

• install: pip install su6[bandit]
• use: su6 bandit
• functionality: security linter
• pypi: bandit

isort

• install: pip install su6[isort]
• use: su6 isort, su6 isort --fix
• functionality: import sorter
• pypi: isort

pydocstyle

• install: pip install su6[pydocstyle]
• use: su6 pydocstyle
• functionality: docstring checker
• pypi: pydocstyle

Usage

su6 --help
# or, easiest to start:
su6 all

License

su6 is distributed under the terms of the MIT license.

Changelog

See CHANGELOG.md on GitHub