Skip to content

README.md

Latest commit

 

History

History
53 lines (40 loc) · 2.75 KB

README.md

File metadata and controls

53 lines (40 loc) · 2.75 KB

poetry pip-tools uv

Python project template

This repo contains a cookiecutter template for a Python project, including pre-commit hooks for linting and GitHub Actions for automatically running tests using pytest.

The template supports three Python packaging tools: poetry, pip-tools and uv.

It is particularly geared towards the needs of Imperial College's Research Software Engineering team, but hopefully it should be generically useful. If you find any problems or have any questions, please raise an issue.

Usage

To use this template for your own application:

  1. Install cookiecutter following the instructions for your OS.
  2. Create your own project using this template: cookiecutter gh:ImperialCollegeLondon/python-template
  3. Choose the options you want for your project
  4. To get started, follow the instructions in the readme of the newly created project

Extra setup

Auto-merging bot PRs

This template optionally includes a GitHub Actions workflow to automatically merge PRs from bots (specifically for dependabot and pre-commit.ci). However, in order for this to work, you will first need to follow GitHub's instructions for enabling auto-merge on your repository.