bstephe9-example-project 1.0.1
This is a template repository for Python projects that use uv for their dependency management.
Requires Python: <4.0,>=3.9
Keywords: python

# bstephe9-example-project

[![Release](https://img.shields.io/github/v/release/bstephe9/bstephe9-example-project)](https://img.shields.io/github/v/release/bstephe9/bstephe9-example-project)
[![Build status](https://img.shields.io/github/actions/workflow/status/bstephe9/bstephe9-example-project/main.yml?branch=main)](https://github.com/bstephe9/bstephe9-example-project/actions/workflows/main.yml?query=branch%3Amain)
[![codecov](https://codecov.io/gh/bstephe9/bstephe9-example-project/branch/main/graph/badge.svg)](https://codecov.io/gh/bstephe9/bstephe9-example-project)
[![Commit activity](https://img.shields.io/github/commit-activity/m/bstephe9/bstephe9-example-project)](https://img.shields.io/github/commit-activity/m/bstephe9/bstephe9-example-project)
[![License](https://img.shields.io/github/license/bstephe9/bstephe9-example-project)](https://img.shields.io/github/license/bstephe9/bstephe9-example-project)

This is a template repository for Python projects that use uv for their dependency management.

- **Github repository**: <https://github.com/bstephe9/bstephe9-example-project/>
- **Documentation** <https://bstephe9.github.io/bstephe9-example-project/>

## Getting started with your project

### 1. Create a New Repository

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:bstephe9/bstephe9-example-project.git
git push -u origin main
```

### 2. Set Up Your Development Environment

Then, install the environment and the pre-commit hooks with

```bash
make install
```

This will also generate your `uv.lock` file

### 3. Run the pre-commit hooks

Initially, the CI/CD pipeline might be failing due to formatting issues. To resolve those run:

```bash
uv run pre-commit run -a
```

### 4. Commit the changes

Lastly, commit the changes made by the two steps above to your repository.

```bash
git add .
git commit -m 'Fix formatting issues'
git push origin main
```

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, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/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/bstephe9/bstephe9-example-project/settings/secrets/actions/new).
- Create a [new release](https://github.com/bstephe9/bstephe9-example-project/releases/new) on Github.
- Create a new tag in the form `*.*.*`.

For more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).

---

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