https://github.com/dirmeier/cookiecutter-uv
Rye cookiecutter template
https://github.com/dirmeier/cookiecutter-uv
cookiecutter-template pypa python uv
Last synced: about 1 year ago
JSON representation
Rye cookiecutter template
- Host: GitHub
- URL: https://github.com/dirmeier/cookiecutter-uv
- Owner: dirmeier
- License: apache-2.0
- Created: 2024-08-19T12:41:55.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-18T14:26:35.000Z (over 1 year ago)
- Last Synced: 2024-12-18T15:31:23.692Z (over 1 year ago)
- Topics: cookiecutter-template, pypa, python, uv
- Language: Python
- Homepage:
- Size: 25.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `uv` cookiecutter template
[](http://www.repostatus.org/#concept)
> My template for Python apps built with `uv`
## About
This repository implements a template for a minimal Python package that uses `uv`+Setuptools for packaging and dependency management.
## Installation
1) Install `cookiecutter` first and then:
```bash
cookiecutter gh:dirmeier/cookiecutter-uv
```
2) After having created a project, install all dependencies using [`uv`](https://github.com/astral-sh/uv):
```shell
uv sync --all-extras
```
3) Init a GitHub repo using
```shell
git init
git remote add origin git git@github.com:{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}.git
```
4) Setup [Codecov](https://about.codecov.io/) and [Codacy](https://www.codacy.com/), or your preferred code coverage and code quality tools.
Fix the respective links in the header of `README.md`.
5) Install `pre-commit` and `gitlint` via:
```shell
pre-commit install
gitlint install-hook
```
6) Create a new branch for development via:
```shell
git checkout -b my-new-feature
```
6) Develop code, implement unit tests and write documentation.
7) Test everything via
```shell
make format
make lints
make tests
make docs
```
8) Commit your changes using an informative commit message. Read [this](https://cbea.ms/git-commit/) for help.
9) Push your changes to your feature branch and create a pull request.
10) Squash-merge your changes onto main or, ideally, clean up your commit history and rebase onto main.
11) Don't forget to create tags and releases.
## Author
Simon Dirmeier sfyrbnd @ pm me