This is a cookiecutter repository to generate the file structure for a Python project that uses Poetry for its dependency management.
- Poetry, obviously.
- CI/CD with GitHub Actions
- Formatting with black and isort
- Linting with flake8
- Publishing to Pypi or Artifactory by creating a new release on GitHub
- Testing with pytest
- Documentation with MkDocs
- Static type checking with mypy
- Compatibility testing for multiple versions of Python with Tox
- Containerization with Docker
On your local machine, navigate to the directory in which you want to create a project directory, and run the following two commands:
pip install cookiecutter-poetry
ccpAlternatively, install cookiecutter and directly pass the URL to this
Github repository to the cookiecutter command:
pip install cookiecutter
cookiecutter https://github.com/fpgmaas/cookiecutter-poetry.gitThen run the following commands, replacing <project-name>, with the
name that you also gave the Github repository and
<github_author_handle> with your Github username.
cd <project_name>
git init -b main
git add .
git commit -m "Init commit"
git remote add origin git@github.com:<github_author_handle>/<project_name>.git
git push -u origin mainFinally, install the environment with make install.
You are now ready to start development on your project! The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.
To finalize the set-up for publishing to PyPi or Artifactory, see here. For activating the automatic documentation with MkDocs, see here.
This project is partially based on Audrey Feldroy's's great cookiecutter-pypackage repository.