This is a template repository for Python projects that use Poetry for their dependency management.
Project description
cookiecutter-poetry-example
This is a template repository for Python projects that use Poetry for their dependency management.
- Github repository: https://github.com/fpgmaas/cookiecutter-poetry-example/
- Documentation https://fpgmaas.github.io/cookiecutter-poetry-example/
Getting started with your project
First, create a repository on GitHub with the same name as this project, and then run the following commands:
git init -b main
git add .
git commit -m "init commit"
git remote add origin git@github.com:fpgmaas/cookiecutter-poetry-example.git
git push -u origin main
Finally, install the environment and the pre-commit hooks 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. To enable the code coverage reports, see here.
Releasing a new version
- Create an API Token on Pypi.
- Add the API Token to your projects secrets with the name
PYPI_TOKEN
by visiting this page. - Create a new release on Github.
Create a new tag in the form
*.*.*
.
For more details, see here.
Repository initiated with fpgmaas/cookiecutter-poetry-example.
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_example-0.4.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9878e283b5377a320266bdea3ad5e415e30647d99f5866e51ac5f554bb028e1e |
|
MD5 | c580669255513ae4115d843431124b35 |
|
BLAKE2b-256 | 264d68114b05457167d6448dbc7592dfe236372d476f7ce97d2ec1b16893dadb |
Hashes for cookiecutter_poetry_example-0.4.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 793400aa6f85ffd00a4712ad0eea6b8c4aa34f09f9a682a844e0c6a229b02f4b |
|
MD5 | 8a7d1cd87ef957dbdf19663a86abeacd |
|
BLAKE2b-256 | 4fe574fea19e195a2860729cafe08fde4d3ab5400aca74bfae6cd2ef89344c37 |