Python Blueprint

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.

Summary:

The Python Blueprint serves as a comprehensive example project for Python developers looking to create Python packages using modern tooling. By leveraging tools like Poetry, Nox, pytest, and mypy, developers can streamline package management, automate testing and code quality checks, and ensure type safety in their projects. The project also demonstrates the packaging and distribution process for Python packages, making it a valuable resource for developers aiming to create high-quality Python projects.