Python Blueprint
Example Python project using best practices
Overview:
The Python Blueprint is an example Python project showcasing the creation of a Python package using modern Python tooling for testing, linting, and type checking. It utilizes Python 3.8+, Poetry for package management, Nox for automation, and mypy for type checking.
Features:
- GitHub Actions: Utilize GitHub Actions for continuous integration and deployment.
- Poetry: Manage project dependencies and virtual environments with Poetry.
- Nox: Automate tasks such as unit testing, linting, and documentation generation with Nox.
- Type checked with mypy: Ensure type safety in the project using mypy.
- Python package structure: Demonstrates best practices in structuring a Python package.
- Unit Testing with pytest: Write and execute unit tests easily with the popular pytest framework.
- Code Quality checking: Enforce code quality with automated checks for PEP 8 compliance and type checking.
- Packaging: Package the project as source distribution and wheel for distribution and installation.
- MkDocs
MkDocs is a fast, simple and downright gorgeous static site generator that's geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML configuration file.
- Docker
A website that uses Docker for containerization to streamline development, testing, and deployment workflows. This includes features such as containerization of dependencies, automated builds and deployments, and container orchestration to ensure scalability and availability.
