This template is structured around integrating advanced tools and configurations to ensure code quality, consistency, and the efficient use of Python and its ecosystem.
makecommands: Simplified commands for initializing, upgrading, cleaning, testing, and formatting the project.PyO3&setuptools_rust: Added support for integrating Rust code into the Python package.- GitHub Actions: Automated building and releasing of Python wheels as GitHub releases.
This project uses various tools and configurations to maintain a high standard of code quality and consistency:
- Ruff: A high-performance Python linter built in Rust. Ruff is utilized in this project for its speed and extensive rule set. It consolidates the functionality of various tools like Flake8, isort, pydocstyle, and more, into a single, fast, and efficient package.
- Black formatter: The code is automatically formatted using the Black code formatter, ensuring a consistent code style across the project.
- isort: Imports are sorted and organized using isort, following the Black-compatible profile.
- pre-commit: A set of pre-commit hooks are used to automatically check and enforce code quality standards, such as trailing whitespace removal, JSON formatting, and more.
- docformatter: The docstrings are formatted using docformatter to ensure consistency and readability.
- pytest: Tests are written and executed using the pytest framework.