https://github.com/jkoessle/uv-copier-template
Very simple copier template for Python projects with src layout and dependency management by uv.
https://github.com/jkoessle/uv-copier-template
copier copier-python copier-template project-template python template uv
Last synced: 5 days ago
JSON representation
Very simple copier template for Python projects with src layout and dependency management by uv.
- Host: GitHub
- URL: https://github.com/jkoessle/uv-copier-template
- Owner: jkoessle
- Created: 2025-03-02T14:38:19.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-03-02T15:16:51.000Z (11 months ago)
- Last Synced: 2025-03-02T15:33:00.168Z (11 months ago)
- Topics: copier, copier-python, copier-template, project-template, python, template, uv
- Language: Jinja
- Homepage:
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Copier UV Template
[](https://github.com/copier-org/copier)
This is a very simple copier template for Python projects with src layout and dependency management by [uv](https://github.com/astral-sh/uv).
## Features
- Automated copier questions
- Setup for [uv](https://github.com/astral-sh/uv)
- Included dev tools for formatting, quality checks and testing:
- [ruff](https://github.com/astral-sh/ruff)
- [pre-commit](https://github.com/pre-commit/pre-commit)
- [black](https://github.com/psf/black)
- [pytest](https://github.com/pytest-dev/pytest/)
- The project is structured in the [src layout](https://www.pyopensci.org/python-package-guide/package-structure-code/python-package-structure.html)
## Usage
### Requirements
You need to have uv and copier installed. Install uv and an accompanying Python version (or use your own Python environment like pyenv or conda):
```bash
curl -LsSf https://astral.sh/uv/install.sh | sh
# optional:
uv python install 3.12
```
Install copier with uv or pipx (this will install uv globally):
```bash
pipx install copier
```
or
```bash
uv tool install copier
```
### Generate a Project
To generate a new project, execute the following command:
```bash
copier copy --trust "gh:jkoessle/uv-copier-template" /path/to/your/new/project
```
It's also possible to use uv directly, without the need to install copier:
```bash
uvx copier copy --trust "gh:jkoessle/uv-copier-template" /path/to/your/new/project
```