This package is configured using bleeding edge toolset and serves as an example/starting point for another new packages.
Commonly used commands for package development:
-
make check
- run unit tests and linters. -
make fix
- format code and fix detected fixable issues. -
make publish
- publishes current package version to pypi.org. -
make compile
- bump and freeze dependency versions in requirements*.txt files -
make sync
- upgrade installed dependencies in Virtual Environment (executed aftermake compile
)
This package uses these cutting edge tools:
- ruff - for linting and code formatting
- mypy - for type checking
- pip-audit - for known vulnerability detection in dependencies
- deadcode - for unused code detection
- pytest - for collecting and running unit tests
- coverage - for code coverage by unit tests
- hatch - for publishing package to pypi.org
- uv - for Python virtual environment and dependency management
- pyproject.toml - configuration file for all tools
- Makefile - aliases for commonly used command line commands