Merge branch 'main' into support_oxford_comma

Author: staticdev

.github/workflows/constraints.txt

@@ -1,2 +1,3 @@
+nox==2024.10.9
 pip==24.3.1
 virtualenv==20.29.0

.github/workflows/release-dev.yml

@@ -2,8 +2,8 @@ name: Release
 
 on:
   push:
-    tags:
-      - "v[0-9]+.[0-9]+.[0-9]+"
+    branches:
+      - main
 
 jobs:
   release:
@@ -21,7 +21,7 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.12"
+          python-version: "3.13"
 
       - name: Upgrade pip
         run: |
@@ -33,9 +33,30 @@ jobs:
           pip install --constraint=.github/workflows/hatch-constraints.txt hatch
           hatch --version
 
+      - name: Check if there is a parent commit
+        id: check-parent-commit
+        run: |
+          echo "::set-output name=sha::$(git rev-parse --verify --quiet HEAD^)"
+
+      - name: Detect and tag new version
+        id: check-version
+        if: steps.check-parent-commit.outputs.sha
+        uses: salsify/action-detect-and-tag-new-version@v2
+        with:
+          version-command: |
+            bash -o pipefail -c "hatch version"
+
+      - name: Bump version for developmental release
+        if: "! steps.check-version.outputs.tag"
+        run: |
+          hatch version b
+
+      - name: Install UV
+        uses: astral-sh/setup-uv@v5
+
       - name: Build package
         run: |
-          hatch build
+          uv build
 
       - name: Publish package on PyPI
         uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/release.yml

@@ -12,21 +12,22 @@ jobs:
       fail-fast: false
       matrix:
         include:
-          - { python: "3.12", os: "ubuntu-latest", session: "pre-commit" }
-          - { python: "3.12", os: "ubuntu-latest", session: "safety" }
+          - { python: "3.13", os: "ubuntu-latest", session: "pre-commit" }
+          - { python: "3.13", os: "ubuntu-latest", session: "mypy" }
           - { python: "3.12", os: "ubuntu-latest", session: "mypy" }
           - { python: "3.11", os: "ubuntu-latest", session: "mypy" }
           - { python: "3.10", os: "ubuntu-latest", session: "mypy" }
           - { python: "3.9", os: "ubuntu-latest", session: "mypy" }
+          - { python: "3.13", os: "ubuntu-latest", session: "tests" }
           - { python: "3.12", os: "ubuntu-latest", session: "tests" }
           - { python: "3.11", os: "ubuntu-latest", session: "tests" }
           - { python: "3.10", os: "ubuntu-latest", session: "tests" }
           - { python: "3.9", os: "ubuntu-latest", session: "tests" }
-          - { python: "3.12", os: "windows-latest", session: "tests" }
-          - { python: "3.12", os: "macos-latest", session: "tests" }
-          - { python: "3.12", os: "ubuntu-latest", session: "typeguard" }
-          - { python: "3.12", os: "ubuntu-latest", session: "xdoctest" }
-          - { python: "3.12", os: "ubuntu-latest", session: "docs-build" }
+          - { python: "3.13", os: "windows-latest", session: "tests" }
+          - { python: "3.13", os: "macos-latest", session: "tests" }
+          - { python: "3.13", os: "ubuntu-latest", session: "typeguard" }
+          - { python: "3.13", os: "ubuntu-latest", session: "xdoctest" }
+          - { python: "3.13", os: "ubuntu-latest", session: "docs-build" }
 
     steps:
       - name: Check out the repository
@@ -42,10 +43,12 @@ jobs:
           pip install --constraint=.github/workflows/constraints.txt pip
           pip --version
 
-      - name: Install Hatch
+      - name: Install UV
+        uses: astral-sh/setup-uv@v5
+
+      - name: Install Nox
         run: |
-          pipx install --pip-args=--constraint=.github/workflows/hatch-constraints.txt hatch
-          hatch --version
+          uv sync --all-extras --frozen
 
       - name: Compute pre-commit cache key
         if: matrix.session == 'pre-commit'
@@ -71,9 +74,9 @@ jobs:
           restore-keys: |
             ${{ steps.pre-commit-cache.outputs.result }}-
 
-      - name: Run Hatch
+      - name: Run Nox
         run: |
-          hatch run +python=${{ matrix.python }} sessions:run-${{ matrix.session }}
+          uv run nox -s tests --force-color --python=${{ matrix.python }}
 
       - name: Upload coverage data
         if: always() && matrix.session == 'tests' && matrix.os == 'ubuntu-latest'
@@ -100,33 +103,32 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.12"
+          python-version: "3.13"
 
       - name: Upgrade pip
         run: |
           pip install --constraint=.github/workflows/constraints.txt pip
           pip --version
 
-      - name: Install Hatch
-        run: |
-          pipx install --pip-args=--constraint=.github/workflows/hatch-constraints.txt hatch
-          hatch --version
+      - name: Install UV
+        uses: astral-sh/setup-uv@v5
 
       - name: Download coverage data
         uses: actions/download-artifact@v4
 
       - name: Combine coverage data and display human readable report
         run: |
           shopt -s dotglob
+          mv coverage-data-3.13-ubuntu-latest/* .
           mv coverage-data-3.12-ubuntu-latest/* .
           mv coverage-data-3.11-ubuntu-latest/* .
           mv coverage-data-3.10-ubuntu-latest/* .
           mv coverage-data-3.9-ubuntu-latest/* .
-          hatch run coverage:run
+          uv run nox --force-color --session=coverage
 
       - name: Create coverage report
         run: |
-          hatch run coverage:run-xml
+          uv run nox --force-color --session=coverage -- xml
 
       - name: Upload coverage report
         uses: codecov/codecov-action@v5

.github/workflows/tests.yml

@@ -39,42 +39,29 @@ Request features on the [Issue Tracker].
 
 You need Python 3.9+ and the following tools:
 
-- [Hatch]
+- [UV]
 
 Install the package with development requirements:
 
-```console
-$ hatch env create
+```sh
+$ uv sync --all-extras --frozen
 ```
 
-You can now run an interactive Python session:
-
-```console
-$ hatch shell
-import human_readable
-```
-
-[hatch]: https://hatch.pypa.io/
+[uv]: https://docs.astral.sh/uv/
 
 ## How to test the project
 
 Run the full test suite:
 
-```console
-$ hatch run all
-```
-
-List the available Hatch env scripts:
-
-```console
-$ hatch env show
+```sh
+$ uv run nox
 ```
 
-You can run a specific Hatch env script.
+You can run a specific Nox session.
 For example, invoke the unit test suite like this:
 
-```console
-$ hatch run tests:run
+```sh
+$ uv run nox -s tests
 ```
 
 Unit tests are located in the `tests` directory,
@@ -84,13 +71,13 @@ and are written using the [pytest] testing framework.
 
 Make sure you have installed a PO Editor, you can easily install that on a Debian-based system with:
 
-```console
+```sh
 apt install poedit
 ```
 
 To add a new locale you need to execute:
 
-```console
+```sh
 xgettext --from-code=UTF-8 -o human_readable.pot -k'_' -k'N_' -k'P_:1c,2' -l python src/human_readable/*.py  # extract new phrases
 msginit -i human_readable.pot -o human_readable/locale/<locale name>/LC_MESSAGES/human_readable.po --locale <locale name>
 ```
@@ -99,7 +86,7 @@ Then edit your .po file in the locale folder that got created.
 
 If possible, add tests to `tests/functional/new_locale`. Run them with:
 
-```console
+```sh
 nox -s tests
 ```
 
@@ -117,7 +104,7 @@ Feel free to submit early, though—we can always iterate on this.
 
 To run linting and code formatting checks before commiting your change, you can install pre-commit as a Git hook by running the following command:
 
-```console
+```sh
 $ nox --session=pre-commit -- install
 ```