🐍 Python Project Template 🚀

A modern Python project template to kickstart your next Python project with all the necessary tools and configurations.

Features

• ✨ Poetry: Manage your project's dependencies and packaging with Poetry.
• 📝 Editorconfig: Ensure consistent code formatting across different editors.
• 🔧 Formatter: Automatically format your code using Ruff formatter and import sorter.
• 🔍 Linters: Catch and prevent errors in your code. Ruff is used for linting and MyPy for type checking.
• 📋 Makefile: Easily execute common project tasks with a Makefile.
• 🧪 Test: Write and run tests for your project using pytest.
• 🔗 GitHub Workflow: Automated GitHub workflow for linting, formatting, and testing your code.

Getting Started

1. Select Use this template > Create a new repository.

2. Install Poetry (if not already installed):

   pipx install poetry
   

3. Replace TODO comments in files with project/repo specific.

TODO

• Use copier or cookiecutter
• Add Docker image
• Add DOC generation in CI/CD