Pypackage
Cookiecutter python package using Poetry, mypy, black, isort, autoflake, pytest, mkdocs, and GitHub Actions
Overview
The template module serves as an excellent collection of utilities, carefully curated from various projects for personal reference. It is designed for developers looking to streamline their Python projects with a robust set of tools and features. With its focus on best practices, this template makes it a breeze to set up a new Python project while ensuring efficiency and maintainability.
This package embraces the latest Python standards by supporting only Python 3.6 and above. Designed to integrate seamlessly with modern development practices, it utilizes a variety of tools that enhance your coding experience from the ground up.
Features
- Poetry: A one-stop tool for managing virtual environments and publishing packages to PyPI with ease.
- Black: Automated code formatting to maintain consistent code style effortlessly.
- Autoflake: Removes unused imports and variables, helping to clean up your codebase.
- Isort: Organizes your imports systematically, promoting cleaner and more readable code.
- Mypy: Enforces static type checking, ensuring your code is type-safe for easier debugging.
- Pytest: Built-in support for comprehensive testing, including coverage reports for your code.
- Pre-commit hooks: Ensures code quality by automatically running checks before commits.
- GitHub Actions for CI/CD: Automates your deployment processes, allowing you to publish easily to PyPI when you release your code.