https://github.com/fpgmaas/cookiecutter-uv

A modern cookiecutter template for Python projects that use uv for dependency management
https://github.com/fpgmaas/cookiecutter-uv

cookiecutter cookiecutter-python python template uv

Last synced: 5 days ago
JSON representation

A modern cookiecutter template for Python projects that use uv for dependency management

• Host: GitHub
• URL: https://github.com/fpgmaas/cookiecutter-uv
• Owner: fpgmaas
• License: mit
• Created: 2024-09-02T06:29:56.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-17T07:16:09.000Z (4 months ago)
• Last Synced: 2024-09-17T22:24:04.588Z (4 months ago)
• Topics: cookiecutter, cookiecutter-python, python, template, uv
• Language: Python
• Homepage: https://fpgmaas.github.io/cookiecutter-uv
• Size: 745 KB
• Stars: 103
• Watchers: 1
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  



---

[![Build status](https://img.shields.io/github/actions/workflow/status/fpgmaas/cookiecutter-uv/main.yml?branch=main)](https://github.com/fpgmaas/cookiecutter-uv/actions/workflows/main.yml?query=branch%3Amain)

[![Supported Python versions](https://img.shields.io/badge/python-3.9_%7C_3.10_%7C_3.11_%7C_3.12_%7C_3.13-blue?labelColor=grey&color=blue)](https://github.com/fpgmaas/cookiecutter-uv/blob/main/pyproject.toml)

[![Docs](https://img.shields.io/badge/docs-gh--pages-blue)](https://fpgmaas.github.io/cookiecutter-uv/)

[![License](https://img.shields.io/github/license/fpgmaas/cookiecutter-uv)](https://img.shields.io/github/license/fpgmaas/cookiecutter-uv)

This is a modern Cookiecutter template that can be used to initiate a Python project with all the necessary tools for development, testing, and deployment. It supports the following features:

- [uv](https://docs.astral.sh/uv/) for dependency management

- CI/CD with [GitHub Actions](https://github.com/features/actions)

- Pre-commit hooks with [pre-commit](https://pre-commit.com/)

- Code quality with [ruff](https://github.com/charliermarsh/ruff), [mypy](https://mypy.readthedocs.io/en/stable/), [deptry](https://github.com/fpgmaas/deptry/) and [prettier](https://prettier.io/)

- Publishing to [PyPI](https://pypi.org) by creating a new release on GitHub

- Testing and coverage with [pytest](https://docs.pytest.org/en/7.1.x/) and [codecov](https://about.codecov.io/)

- Documentation with [MkDocs](https://www.mkdocs.org/)

- Compatibility testing for multiple versions of Python with [tox-uv](https://github.com/tox-dev/tox-uv)

- Containerization with [Docker](https://www.docker.com/)

- Development environment with [VSCode devcontainers](https://code.visualstudio.com/docs/devcontainers/containers)

---



  Documentation - Example



---

## Quickstart

On your local machine, navigate to the directory in which you want to

create a project directory, and run the following command:

```bash

uvx cookiecutter https://github.com/fpgmaas/cookiecutter-uv.git

```

or if you don't have `uv` installed yet:

```bash

pip install cookiecutter

cookiecutter https://github.com/fpgmaas/cookiecutter-uv.git

```

Follow the prompts to configure your project. Once completed, a new directory containing your project will be created. Then navigate into your newly created project directory and follow the instructions in the `README.md` to complete the setup of your project.

## Acknowledgements

This project is partially based on [Audrey

Feldroy\'s](https://github.com/audreyfeldroy)\'s great

[cookiecutter-pypackage](https://github.com/audreyfeldroy/cookiecutter-pypackage)

repository.