docs: improve docs

Author: billwallis

.github/workflows/tests.yaml

@@ -14,20 +14,19 @@ jobs:
       - name: 🛎️ Check out repository
         uses: actions/checkout@v4
 
-      - name: 📦 Set up UV
+      - name: 📦 Set up uv
         uses: astral-sh/setup-uv@v5
         with:
-          version: "0.6.5"
+          version: "0.6.12" # reminder: keep aligned with the pre-commit hooks
           enable-cache: true
 
       - name: 🐍 Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: 3.11
           python-version-file: "pyproject.toml"
 
       - name: 🔨 Install dependencies
-        run: uv sync --group test
+        run: uv sync --no-default-groups --group test
 
       - name: ✅ Run unit tests
         run: uv run pytest -vvv

.pre-commit-config.yaml

@@ -32,7 +32,7 @@ repos:
         name: Validate Python
 
   - repo: https://github.com/astral-sh/uv-pre-commit
-    rev: 0.6.12
+    rev: 0.6.12 # reminder: keep aligned with the GitHub actions
     hooks:
       - id: uv-lock
         name: Check that the lock file is up-to-date

README.md

@@ -1,6 +1,6 @@
 <div align="center">
 
-[![Python](https://img.shields.io/badge/Python-3.11+-blue.svg)](https://www.python.org/downloads/release/python-3110/)
+[![Python](https://img.shields.io/badge/Python-3.11+-blue.svg)](https://www.python.org/downloads/)
 [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 [![tests](https://github.com/Bilbottom/python-template/actions/workflows/tests.yaml/badge.svg)](https://github.com/Bilbottom/python-template/actions/workflows/tests.yaml)
 [![coverage](coverage.svg)](https://github.com/dbrgn/coverage-badge)
@@ -22,3 +22,12 @@ After copying, find and replace on:
 
 - `python-template` -> new repo name
 - `src` -> new package name (optional)
+
+## Quick start
+
+Install [uv](https://docs.astral.sh/uv/getting-started/installation/) and then enable [pre-commit](https://pre-commit.com/):
+
+```bash
+uv sync --all-groups
+pre-commit install --install-hooks
+```

pyproject.toml

@@ -22,6 +22,14 @@ test = [
 ]
 
 
+[tool.setuptools]
+packages = ["src"]
+
+# https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html
+#[tool.setuptools.packages.find]
+#include = ["src"]
+
+
 [tool.pytest.ini_options]
 addopts = "--cov=src --cov-fail-under=80"
 testpaths = ["tests"]