https://github.com/fpgmaas/cookiecutter-poetry-example
An example of a project generated with cookiecutter-poetry.
https://github.com/fpgmaas/cookiecutter-poetry-example
Last synced: 12 months ago
JSON representation
An example of a project generated with cookiecutter-poetry.
- Host: GitHub
- URL: https://github.com/fpgmaas/cookiecutter-poetry-example
- Owner: fpgmaas
- License: mit
- Created: 2022-04-18T06:30:29.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-08T14:03:51.000Z (almost 2 years ago)
- Last Synced: 2025-07-11T01:58:44.026Z (about 1 year ago)
- Language: Makefile
- Homepage: https://github.com/fpgmaas/cookiecutter-poetry
- Size: 329 KB
- Stars: 16
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# cookiecutter-poetry-example
[](https://img.shields.io/github/v/release/fpgmaas/cookiecutter-poetry-example)
[](https://github.com/fpgmaas/cookiecutter-poetry-example/actions/workflows/main.yml?query=branch%3Amain)
[](https://codecov.io/gh/fpgmaas/cookiecutter-poetry-example)
[](https://img.shields.io/github/commit-activity/m/fpgmaas/cookiecutter-poetry-example)
[](https://img.shields.io/github/license/fpgmaas/cookiecutter-poetry-example)
This is a template repository for Python projects that use Poetry for their dependency management.
- **Github repository**:
- **Documentation**
## Getting started with your project
First, create a repository on GitHub with the same name as this project, and then run the following commands:
```bash
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
```bash
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](https://fpgmaas.github.io/cookiecutter-poetry/features/publishing/#set-up-for-pypi).
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/mkdocs/#enabling-the-documentation-on-github).
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/codecov/).
## Releasing a new version
- Create an API Token on [PyPI](https://pypi.org/).
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/fpgmaas/cookiecutter-poetry-example/settings/secrets/actions/new).
- Create a [new release](https://github.com/fpgmaas/cookiecutter-poetry-example/releases/new) on Github.
- Create a new tag in the form `*.*.*`.
- For more details, see [here](https://fpgmaas.github.io/cookiecutter-poetry/features/cicd/#how-to-trigger-a-release).
---
Repository initiated with [fpgmaas/cookiecutter-poetry](https://github.com/fpgmaas/cookiecutter-poetry).