A python cookiecutter application to create a new python project that uses poetry to manage its dependencies.
Project description
Cookiecutter Poetry
This is a cookiecutter repository to generate the file structure for a Python project that uses Poetry for its dependency management.
Features
- 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
- Test coverage with codecov
- Documentation with MkDocs
- Static type checking with mypy
- Compatibility testing for multiple versions of Python with Tox
- Containerization with Docker
Example CI/CD Pipeline
Quickstart
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
ccp
Alternatively, 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.git
Then 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 main
Finally, 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.
Acknowledgements
This project is partially based on Audrey Feldroy's's great cookiecutter-pypackage repository.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cookiecutter-poetry-0.3.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30efcc1d2d8d6c7a27b6f978219616d5d99959d71f1df77989dc38c105266176 |
|
MD5 | 28d66e8dd645715f30defcc96d1d44ef |
|
BLAKE2b-256 | e385b72a27c4d3a4376a65d7716166954c05f22ca55793ea7407e81074ef9c2c |
Hashes for cookiecutter_poetry-0.3.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b8e38ade7f3ce63643b66c531d7bde3ffea927a671856066afee1da5c1ed615 |
|
MD5 | 1f2656f06fb7489f863991a7debee706 |
|
BLAKE2b-256 | 40ba06aeb774f5e0162c098a2e8034e949dfe3b93285e2f109bc837a4f8a29e8 |