[Cookiecutter][cookiecutter] ๐ช template for a modern Python package ๐๐ฆ.
* GitHub repo:
* Documentation:
* Free software: MIT license
## ๐ Features
* **Dependency tracking:** ๐ฆ Utilizes [Poetry][poetry] for efficient package management.
* **Testing setup:** ๐งช Includes [Pytest][pytest] for comprehensive and reliable testing.
* **Continuous Integration:** ๐ [Github Actions][github_actions] integration for seamless CI testing.
* **Linting:** ๐งน Enhanced code quality with [Ruff][ruff].
* **Docstring:** ๐ Follows the [Google Python Style Guide][google_styleguide] for clear and consistent documentation.
* **Static type checking:** ๐ Ensured by [Mypy][mypy].
* **Formatting:** โจ Consistent code formatting with [Black][black] and [Isort][isort].
* **Security checks:** ๐ Uses [Safety][safety] to identify and address known vulnerabilities.
* **Git hooks:** ๐ฃ Managed by [pre-commit][pre-commit] for streamlined development workflows.
* **Development tasks CLI:** ๐ ๏ธ All-in-one Python CLI provided by [invoke][invoke].
* **Multiple Python environments testing:** ๐ฅ Supported by [Nox][nox].
* **Documentation:** ๐ Utilizes [Sphinx][sphinx] for clear and comprehensive documentation, ready for [Read the Docs][rtd].
* **Command line interface:** ๐ป Optional integration with [Typer][typer].
* **Automated dependency updates:** ๐ค Enabled by [Dependabot][dependabot].
* **Coverage reports:** ๐ Integrated with [Codecov][codecov].
* **Automated releases:** ๐ข Push a new tag to trigger releases to [PyPI][pypi] and [TestPyPI][testpypi].
* **GitHub community health files (optional):**
- [Code of Condunct][CODE_OF_CONDUCT.md] ๐ค
- [Contributing][CONTRIBUTING.md] ๐
- [Security][SECURITY.md] ๐
- [Code Owners][CODEOWNERS] ๐ฉโ๐ผ
- [Funding][FUNDING.yml] ๐ฐ
- [Citation][CITATION.cff] ๐
## โก๏ธ Quickstart
Get started with your modern Python package in just a few steps:
### 1. Install Cookiecutter
If you haven't installed Cookiecutter yet, make sure to have version 1.4.0 or higher:
```sh
pip install -U cookiecutter
```
### 2. Generate your Python Package
Run Cookiecutter using the latest release
```sh
cookiecutter gh:fedejaure/cookiecutter-modern-pypackage --checkout v3.0.1
```
### 3. Set up Your Project
Follow these steps to complete the setup:
* Create a new GitHub repository and push your generated project there.
* Install the development requirements into a virtual environment:
```sh
poetry install
```
* Install pre-commit hooks:
```sh
poetry run inv install-hooks
```
* Configure [Codecov][codecov] repository settings. (Codecov App, `CODECOV_TOKEN`)
* Add your repository to your [Read the Docs][rtd] account and enable the Read the Docs service hook.
* Configure [PyPI][pypi] and [TestPyPI][testpypi] tokens. (`PYPI_TOKEN`, `TEST_PYPI_TOKEN`)
* Release your package by pushing a new tag.
> [!TIP]
> For more details, see the [tutorial][tutorial].
## ๐ Credits
This cookiecutter was built for learning purpose and inspired by:
* [audreyr/cookiecutter-pypackage][audreyr/cookiecutter-pypackage]: Cookiecutter template for a Python package.
* [briggySmalls/cookiecutter-pypackage][briggySmalls/cookiecutter-pypackage]: A fork from [audreyr/cookiecutter-pypackage][audreyr/cookiecutter-pypackage] using Poetry for package management, with linting, formatting and more.
* [hypermodern-python][hypermodern-python]: Hypermodern Python article series.
[cookiecutter]: https://github.com/cookiecutter/cookiecutter
[poetry]: https://python-poetry.org/
[pytest]: https://github.com/pytest-dev/pytest
[github_actions]: https://github.com/features/actions
[ruff]: https://github.com/astral-sh/ruff
[isort]: https://github.com/timothycrosley/isort
[black]: https://github.com/psf/black
[mypy]: https://github.com/python/mypy
[pre-commit]: https://pre-commit.com/
[safety]: https://github.com/pyupio/safety
[google_styleguide]: https://google.github.io/styleguide/pyguide.html
[invoke]: https://www.pyinvoke.org/
[sphinx]: https://www.sphinx-doc.org/en/master/
[rtd]: https://readthedocs.org/
[nox]: https://nox.thea.codes/en/stable/
[tutorial]: https://cookiecutter-modern-pypackage.readthedocs.io/en/latest/tutorial.html
[typer]: https://typer.tiangolo.com/
[dependabot]: https://dependabot.com/
[audreyr/cookiecutter-pypackage]: https://github.com/audreyr/cookiecutter-pypackage
[briggySmalls/cookiecutter-pypackage]: https://github.com/briggySmalls/cookiecutter-pypackage
[hypermodern-python]: https://cjolowicz.github.io/posts/hypermodern-python-01-setup/
[codecov]: https://codecov.io/
[pypi]: https://pypi.org/
[testpypi]: https://test.pypi.org/
[contributor-covenant]: https://www.contributor-covenant.org/
[CODE_OF_CONDUCT.md]: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project
[CONTRIBUTING.md]: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors
[SECURITY.md]: https://docs.github.com/en/code-security/getting-started/adding-a-security-policy-to-your-repository
[CODEOWNERS]: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
[FUNDING.yml]: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository
[CITATION.cff]: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files