Modern Python Boilerplate

Overview

The Modern Python Boilerplate serves as a robust foundation for developing new Python projects, ensuring that developers have access to the latest tools, structure, and best practices. Created by Corentin Meyer, a PhD in Biomedical AI, this boilerplate is meticulously designed to streamline the development process and facilitate effective collaboration.

With its comprehensive approach, this boilerplate includes pre-configured elements that not only enhance productivity but also ensure that the project adheres to modern standards. Whether you're launching a new application or refining an existing one, this boilerplate can significantly simplify the setup and maintenance of your Python projects.

Features

• Global Makefile: A centralized Makefile allows you to run all necessary commands effortlessly. Simply use make help to discover the available commands.

• Python Management: Utilizes UV for seamless management of Python versions and dependencies, ensuring your project runs on the correct setup with minimal hassle.

• Project Structure: Follows a clean and organized src/package structure, promoting maintainability and scalability in your codebase.

• Continuous Integration: Easily integrate CI tools with commands like make allci, enhancing your workflow and automating checks.

• Code Quality Tools: Incorporates Ruff for linting, formatting, and type checking with simple commands such as make check, make format, and make type.

• Testing Framework: Employs Pytest for running tests, including coverage reports with make cov, ensuring your application is thoroughly validated.

• Pre-commit Hooks: Automatically format and check your code before commits, streamlining the code review process and improving overall quality.