diff --git a/README.md b/README.md index 6a1f381..4d170b7 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,36 @@ [//]: # (FIXME) -# python-project-template + +# ๐Ÿ Python Project Template ๐Ÿš€ [//]: # (FIXME) ![example workflow](https://github.com/ankandrew/python-project-template/actions/workflows/main.yaml/badge.svg) -Replace `FIXME` comments in files with project/repo specific. +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 (Black & Isort)**: Automatically format your code using Black and Isort. +- ๐Ÿ“‹ **Makefile**: Easily execute common project tasks with a Makefile. +- ๐Ÿงช **Pytest**: Write and run tests for your project. +- ๐Ÿ” **Mypy**: Catch and prevent type-related errors in your code. +- ๐Ÿ”— **GitHub Workflow**: Automated GitHub workflow for linting, formatting, and testing your code with every push. +- ๐Ÿ”ง **Modern Tools**: Use modern Python tools and best practices for development. + +## Getting Started + +1. Select `Use this template > Create a new repository`. + +2. Install Poetry (if not already installed): + + ```bash + pipx install poetry + +3. Replace `FIXME` comments in files with project/repo specific. + +### TODO + +- [ ] Use `copier` or `cookiecutter` +- [ ] Add Docker image +- [ ] Add DOC generation in CI/CD