semvec/pypi-packages huggingface dataset:
cookiecutter-poetry-example 0.4.6
This is a template repository for Python projects that use Poetry for their dependency management.
Requires Python: >=3.8,<=3.11

# cookiecutter-poetry-example

[![Release](https://img.shields.io/github/v/release/fpgmaas/cookiecutter-poetry-example)](https://img.shields.io/github/v/release/fpgmaas/cookiecutter-poetry-example)
[![Build status](https://img.shields.io/github/workflow/status/fpgmaas/cookiecutter-poetry-example/Main/main)](https://github.com/fpgmaas/cookiecutter-poetry-example/actions/workflows/main.yml?query=branch%3Amain)
[![codecov](https://codecov.io/gh/fpgmaas/cookiecutter-poetry-example/branch/main/graph/badge.svg)](https://codecov.io/gh/fpgmaas/cookiecutter-poetry-example)
[![Commit activity](https://img.shields.io/github/commit-activity/m/fpgmaas/cookiecutter-poetry-example)](https://img.shields.io/github/commit-activity/m/fpgmaas/cookiecutter-poetry-example)
[![License](https://img.shields.io/github/license/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**: <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:

``` 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-example/features/publishing/#set-up-for-pypi).
For activating the automatic documentation with MkDocs, see
[here](https://fpgmaas.github.io/cookiecutter-poetry-example/features/mkdocs/#enabling-the-documentation-on-github).
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-poetry-example/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-example/releasing.html).

---

Repository initiated with [fpgmaas/cookiecutter-poetry-example](https://github.com/fpgmaas/cookiecutter-poetry-example).