diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 2fbe477..c998d9a 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -45,18 +45,10 @@ If you are proposing a feature:
Ready to contribute?
-You need Python >= 3.10 and [hatch](https://github.com/pypa/hatch). You can install it globally with
-[pipx](https://github.com/pypa/pipx):
-
-```console
-$ pipx install hatch
-```
-
-or locally with (this will install it in the local virtual environment):
-
-```console
-$ python -m pip install hatch
-```
+You need Python >= 3.10 and [uv](https://github.com/astral-sh/uv). Please refer to the
+[installation instructions](https://docs.astral.sh/uv/getting-started/installation/) in the `uv` documentation. For
+convenience in running project tasks, we recommend using the `just` command runner. See the documentation for
+[installation instructions](https://github.com/casey/just#installation).
Here's how to set up `python-re3data` for local development.
@@ -68,12 +60,12 @@ Here's how to set up `python-re3data` for local development.
$ git clone git@github.com:username/python-re3data.git
```
-3. Install your local copy into a virtual environment. Assuming you have hatch installed, this is how you set up your
+3. Install your local copy into a virtual environment. Assuming you have `uv` installed, this is how you set up your
fork for local development:
```console
$ cd python-re3data
- $ hatch shell
+ $ uv sync --frozen
```
4. Create a branch for local development:
@@ -84,11 +76,11 @@ Here's how to set up `python-re3data` for local development.
Now you can make your changes locally.
-5. When you're done making changes, check that your changes pass pre-commit and the tests:
+5. When you're done making changes, check that your changes pass `pre-commit` and the tests:
```console
- $ hatch run check
- $ hatch run cov
+ $ just check
+ $ just cov
```
6. Commit your changes and push your branch to GitHub:
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
deleted file mode 100644
index 625fecc..0000000
--- a/.github/workflows/docs.yml
+++ /dev/null
@@ -1,45 +0,0 @@
-name: Docs
-
-on:
- release:
- types: [created]
- workflow_call:
- workflow_dispatch: # run manually from actions tab
-
-# Set permissions at the job level.
-permissions: {}
-
-env:
- PYTHONUNBUFFERED: 1
-
-jobs:
- docs:
- # Disables this workflow from running in a repository that is not part of the indicated organization/user
- if: github.repository_owner == 'afuetterer'
- runs-on: ubuntu-24.04
- permissions:
- contents: write
- steps:
- - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- with:
- fetch-depth: 0 # fetch all commits and branches
- - name: Set up Python 3.13
- uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
- with:
- python-version: '3.13'
- - uses: actions/cache@1bd1e32a3bdc45362d1e726936510720a7c30a57 # v4.2.0
- with:
- key: docs-${{ hashFiles('pyproject.toml') }}
- path: ~/.cache/pip
- - name: Install pre-requisites (e.g. hatch)
- run: python -m pip install --require-hashes --requirement=requirements/ci
- - run: hatch run docs:cli
- - run: hatch run docs:build
- if: github.event_name == 'pull_request'
- - run: |
- hatch version
- hatch run docs:deploy
- if: contains(fromJSON('["release", "workflow_dispatch"]'), github.event_name)
- env:
- GIT_COMMITTER_NAME: github-actions[bot]
- GIT_COMMITTER_EMAIL: 41898282+github-actions[bot]@users.noreply.github.com
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
index afeb667..150da57 100644
--- a/.github/workflows/pr.yml
+++ b/.github/workflows/pr.yml
@@ -18,14 +18,30 @@ permissions: {}
env:
PYTHONUNBUFFERED: 1
FORCE_COLOR: 1
+ UV_FROZEN: true # do not update the lockfile during `uv sync` and `uv run` commands
jobs:
test:
uses: ./.github/workflows/test.yml
+
docs:
- permissions:
- contents: write
- uses: ./.github/workflows/docs.yml
+ # disables this workflow from running in a repository that is not part of the indicated organization/user
+ if: github.repository_owner == 'afuetterer'
+ runs-on: ubuntu-24.04
+ steps:
+ - name: Set up just
+ uses: extractions/setup-just@v2
+ - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+ - name: Set up uv
+ uses: astral-sh/setup-uv@4db96194c378173c656ce18a155ffc14a9fc4355 # v5.2.2
+ with:
+ python-version: '3.13'
+ enable-cache: true
+ prune-cache: false
+ cache-suffix: docs
+ - run: just sync-docs
+ - run: just docs-build
+
required-checks-pass:
if: always()
needs:
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
index 52ff1f0..f0451f1 100644
--- a/.github/workflows/publish.yml
+++ b/.github/workflows/publish.yml
@@ -8,6 +8,9 @@ on:
# Set permissions at the job level.
permissions: {}
+env:
+ UV_FROZEN: true # do not update the lockfile during `uv sync` and `uv run` commands
+
jobs:
build:
name: Build the package
@@ -17,6 +20,7 @@ jobs:
steps:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- uses: hynek/build-and-inspect-python-package@b5076c307dc91924a82ad150cdd1533b444d3310 # v2.12.0
+
upload:
name: Upload package distributions to GitHub Releases
# disables this workflow from running in a repository that is not part of the indicated organization/user
@@ -35,6 +39,7 @@ jobs:
uses: softprops/action-gh-release@c95fe1489396fe8a9eb87c0abf8aa5b2ef267fda # v2.2.1
with:
files: dist/*
+
publish:
# disables this workflow from running in a repository that is not part of the indicated organization/user
if: github.repository_owner == 'afuetterer'
@@ -95,3 +100,28 @@ jobs:
labels: ${{ steps.meta.outputs.labels }}
# Ref: https://docs.docker.com/build/attestations/slsa-provenance/
provenance: false
+
+ docs:
+ # disables this workflow from running in a repository that is not part of the indicated organization/user
+ if: github.repository_owner == 'afuetterer'
+ runs-on: ubuntu-24.04
+ permissions:
+ contents: write
+ steps:
+ - name: Set up just
+ uses: extractions/setup-just@v2
+ - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+ with:
+ fetch-depth: 0 # fetch all commits and branches
+ - name: Set up uv
+ uses: astral-sh/setup-uv@4db96194c378173c656ce18a155ffc14a9fc4355 # v5.2.2
+ with:
+ python-version: '3.13'
+ enable-cache: true
+ prune-cache: false
+ cache-suffix: docs
+ - run: just sync-docs
+ - run: just docs-deploy
+ env:
+ GIT_COMMITTER_NAME: github-actions[bot]
+ GIT_COMMITTER_EMAIL: 41898282+github-actions[bot]@users.noreply.github.com
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index d87e615..9ee3a42 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -9,6 +9,7 @@ permissions: {}
env:
PYTHONUNBUFFERED: 1
FORCE_COLOR: 1
+ UV_FROZEN: true # do not update the lockfile during `uv sync` and `uv run` commands
jobs:
test:
@@ -18,23 +19,26 @@ jobs:
matrix:
python-version: ['3.10', '3.12', '3.13']
steps:
+ - name: Set up just
+ uses: extractions/setup-just@v2
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- - name: Set up Python ${{ matrix.python-version }}
- uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
+ - name: Set up uv
+ uses: astral-sh/setup-uv@4db96194c378173c656ce18a155ffc14a9fc4355 # v5.2.2
with:
python-version: ${{ matrix.python-version }}
- cache: pip
- - name: Install pre-requisites (e.g. hatch)
- run: python -m pip install --require-hashes --requirement=requirements/ci
+ enable-cache: true
+ prune-cache: false
+ - name: Install project, including dev dependencies
+ run: just sync
- name: Run test suite
- run: hatch run cov
+ run: just cov
env:
TERM: dumb # keep rich from printing escape sequences, which made testing CLI outputs messy
- name: Generate coverage report
run: |
export TOTAL_COV=$(hatch run cov-total)
echo "TOTAL_COV=$TOTAL_COV" >> $GITHUB_ENV
- hatch run cov-report-markdown
+ just cov-report-markdown
echo "### Total coverage: ${TOTAL_COV}%" >> $GITHUB_STEP_SUMMARY
cat coverage.md >> $GITHUB_STEP_SUMMARY
if: matrix.python-version == '3.13'
@@ -66,17 +70,18 @@ jobs:
matrix:
os: [ubuntu-latest, windows-latest, macos-latest]
steps:
+ - name: Set up just
+ uses: extractions/setup-just@v2
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- - uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0
+ - name: Set up uv
+ uses: astral-sh/setup-uv@4db96194c378173c656ce18a155ffc14a9fc4355 # v5.2.2
with:
python-version: '3.13'
- cache: pip
- - run: python -Im pip install --editable .[dev]
+ enable-cache: true
+ prune-cache: false
+ - run: just sync
- run: python -Ic 'import re3data; print(re3data.__version__)'
- run: re3data --version
- - name: Set up pipdeptree
- if: matrix.os == 'ubuntu-latest'
- run: python -m pip install --require-hashes --requirement=requirements/ci
- name: Write info to step summary
if: matrix.os == 'ubuntu-latest'
run: |
@@ -84,13 +89,13 @@ jobs:
echo -e "### ✓ All dependencies installed successfully\n\n"
echo 'Installed Python packages (dependency tree)
'
echo -e "\n\`\`\`console"
- echo "$ uv pip tree --package=python-re3data"
- uv pip tree --package=python-re3data
+ echo "$ uv tree --no-group={dev,test}"
+ uv tree --no-group={dev,test}
echo -e "\`\`\`\nOutdated Python packages
'
echo -e "\n\`\`\`console"
- echo "$ python -m pip list --outdated"
- python -m pip list --outdated
+ echo "$ uv pip list --outdated"
+ uv pip list --outdated
echo -e "\`\`\`\n