Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fpgmaas/cookiecutter-uv-example
An example of a project generated with cookiecutter-uv
https://github.com/fpgmaas/cookiecutter-uv-example
python uv
Last synced: 15 days ago
JSON representation
An example of a project generated with cookiecutter-uv
- Host: GitHub
- URL: https://github.com/fpgmaas/cookiecutter-uv-example
- Owner: fpgmaas
- License: mit
- Created: 2024-09-03T08:44:24.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2024-09-10T07:50:03.000Z (2 months ago)
- Last Synced: 2024-09-10T10:05:15.038Z (2 months ago)
- Topics: python, uv
- Language: Makefile
- Homepage: https://github.com/fpgmaas/cookiecutter-uv
- Size: 737 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# cookiecutter-uv-example
[](https://img.shields.io/github/v/release/fpgmaas/cookiecutter-uv-example)
[](https://github.com/fpgmaas/cookiecutter-uv-example/actions/workflows/main.yml?query=branch%3Amain)
[](https://codecov.io/gh/fpgmaas/cookiecutter-uv-example)
[](https://img.shields.io/github/commit-activity/m/fpgmaas/cookiecutter-uv-example)
[](https://img.shields.io/github/license/fpgmaas/cookiecutter-uv-example)
This is a template repository for Python projects that use uv for their dependency management.
- **Github repository**:
- **Documentation**
## 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 [email protected]:fpgmaas/cookiecutter-uv-example.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/fpgmaas/cookiecutter-uv-example/settings/secrets/actions/new).
- Create a [new release](https://github.com/fpgmaas/cookiecutter-uv-example/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).