Merge pull request #91 from remarkablemark/build/uv

build: migrate to uv

Author: remarkablemark

.github/CONTRIBUTING.md

@@ -17,34 +17,22 @@ cd python-package-template
 
 ## Install
 
-Install [Python](https://www.python.org/):
+Install [uv](https://docs.astral.sh/uv/):
 
 ```sh
-brew install python
+curl -LsSf https://astral.sh/uv/install.sh | sh
 ```
 
-Create the virtual environment:
+Install with development dependencies:
 
 ```sh
-python3 -m venv .venv
-```
-
-Activate the virtual environment:
-
-```sh
-source .venv/bin/activate
-```
-
-Install the dependencies:
-
-```sh
-pip install -e '.[build,docs,lint,test]'
+uv sync --all-extras
 ```
 
 Install pre-commit into your git hooks:
 
 ```sh
-pre-commit install
+uv run pre-commit install
 ```
 
 ## Develop
@@ -74,104 +62,80 @@ Things that will improve the chance that your pull request will be accepted:
 
 ## Test
 
-Install the dependencies:
-
-```sh
-pip install -e '.[test]'
-```
-
 Run the tests:
 
 ```sh
-pytest
+uv run pytest
 ```
 
 Run the tests with [coverage](https://coverage.readthedocs.io/):
 
 ```sh
-coverage run -m pytest
+uv run coverage run -m pytest
 ```
 
 Generate a coverage report:
 
 ```sh
-coverage report
+uv run coverage report
 ```
 
 ```sh
-coverage html
+uv run coverage html
 ```
 
 ## Lint
 
-Install the dependencies:
-
-```sh
-pip install -e '.[lint]'
-```
-
 Update pre-commit hooks to the latest version:
 
 ```sh
-pre-commit autoupdate
+uv run pre-commit autoupdate
 ```
 
 Run all pre-commit hooks:
 
 ```sh
-pre-commit run --all-files
+uv run pre-commit run --all-files
 ```
 
 Lint all files in the current directory:
 
 ```sh
-ruff check
+uv run ruff check --fix
 ```
 
 Format all files in the current directory:
 
 ```sh
-ruff format
+uv run ruff format
 ```
 
 ## Build
 
-Install the dependencies:
-
-```sh
-pip install -e '.[build]'
-```
-
 Generate distribution packages:
 
 ```sh
-python3 -m build
+uv build
 ```
 
 Upload all of the archives under `dist`:
 
 ```sh
-twine upload --repository testpypi dist/*
+uv publish --publish-url https://test.pypi.org/legacy/
 ```
 
 Install the package:
 
 ```sh
-pip install --index-url https://test.pypi.org/simple/ --no-deps python-package-template
+uv add --index-url https://test.pypi.org/simple/ --no-deps python-package-template
 ```
 
 ## Docs
 
-Install the dependencies:
-
-```sh
-pip install -e '.[docs]'
-```
-
 Generate the docs with [pdoc](https://pdoc.dev/):
 
 ```sh
-pdoc src/python_package_template/
+uv run pdoc src/python_package_template/
 ```
 
 ## Release

.github/workflows/lint.yml

@@ -11,23 +11,20 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v6
 
-      - name: Use Python
-        uses: actions/setup-python@v6
-        with:
-          cache: pip
-          python-version-file: pyproject.toml
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
 
       - name: Install dependencies
-        run: pip install -e .[lint]
+        run: uv sync --extra lint
 
       - name: Type check
-        run: mypy .
+        run: uv run mypy .
 
       - name: Run Black
-        run: black --check .
+        run: uv run black --check .
 
       - name: Run Ruff
-        run: ruff check
+        run: uv run ruff check
 
       - name: Run pre-commit hooks
-        run: pre-commit run --all-files
+        run: uv run pre-commit run --all-files

.github/workflows/release-please.yml

@@ -35,16 +35,11 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v6
 
-      - name: Use Python
-        uses: actions/setup-python@v6
-        with:
-          python-version-file: pyproject.toml
-
-      - name: Install build
-        run: python -m pip install build
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
 
       - name: Build package
-        run: python -m build
+        run: uv build
 
       - name: Publish package to PyPI
-        uses: pypa/gh-action-pypi-publish@release/v1
+        run: uv publish

.github/workflows/test.yml

@@ -11,20 +11,17 @@ jobs:
       - name: Checkout repository
         uses: actions/checkout@v6
 
-      - name: Use Python
-        uses: actions/setup-python@v6
-        with:
-          cache: pip
-          python-version-file: pyproject.toml
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
 
       - name: Install dependencies
-        run: pip install -e .[test]
+        run: uv sync --extra test
 
-      - name: Run tests and collect coverage
+      - name: Run tests with coverage
         run: |
-          coverage run -m pytest
-          coverage report
-          coverage xml
+          uv run coverage run -m pytest
+          uv run coverage report
+          uv run coverage xml
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v5

README.md

@@ -9,10 +9,17 @@
 ## Prerequisites
 
 - [Python](https://www.python.org/)
+- [uv](https://docs.astral.sh/uv/) or pip
 
 ## Install
 
-Install the package:
+Install with uv:
+
+```sh
+uv add python-package-template
+```
+
+Install with pip:
 
 ```sh
 pip install python-package-template

pyproject.toml

@@ -16,10 +16,6 @@ license-files = ["LICENSE"]
 dependencies = []
 
 [project.optional-dependencies]
-build = [
-    "build==1.4.0",
-    "twine==6.2.0",
-]
 docs = [
     "pdoc==16.0.0",
 ]
@@ -39,6 +35,10 @@ test = [
 Homepage = "https://github.com/remarkablemark/python-package-template"
 Issues = "https://github.com/remarkablemark/python-package-template/issues"
 
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
 [tool.black]
 fast = true