A python cookiecutter application to create a new python project that uses poetry to manage its dependencies.
Project description
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.11.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f7ee0b587572c17c1004d849a0ade19aa50582b3fdd2ec8044c1546592a047d5 |
|
MD5 | fa5aedcc79face00ec69d5e13040b72d |
|
BLAKE2b-256 | 003fd9021851b549b987adf565dd0ac89d58a7358b4c431ed8a98bfa49b74fe7 |
Hashes for cookiecutter_poetry-0.3.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 957a5e355fcfa0e8e5db8cb1bfb4898690cb1a8834674948135de506ec0d12fb |
|
MD5 | 14fcc1b8301acdd5659200ee45ab3313 |
|
BLAKE2b-256 | 7fada2d8c838e0c2350775d6fd8bf057c9ba0389e533d909f5325217a435a5c6 |