chore: migrate to flit

Author: liborjelinek

.github/workflows/test-lint.yml

@@ -19,4 +19,4 @@ jobs:
       - name: Set up Python
         run: uv python install
       - name: Test and lint
-        run: uv run nox -s test mypy ruff_check
+        run: uv run nox -t test lint

docs/changelog.rst

@@ -4,13 +4,14 @@ Changelog
 Unreleased
 **********
 
-A maintenance release with no new features, but with some code and legal clean-up.
+A maintenance release with no new features, but with important code clean-up, dependencies update and modernization.
 
-- minimal Python >= 3.11
-- minimal Sphinx >= 7.4
+- require Python >= 3.11
+- require Sphinx >= 7.4
 - change license from BSD3 to MIT
 - migrate from pip to uv
 - migrate from tox to nox
+- migrate from Build/Twine to Flit
 
 0.1.6 (2025-03-22)
 ******************

noxfile.py

@@ -45,7 +45,7 @@ def install_dependencies(session: nox.Session, *args, **kwargs) -> None:
 # To invoke session(s), use "nox -s <name1>" or "nox -s <name1> <name2>"
 
 
-@nox.session(python=SUPPORTED_PYTHONS)
+@nox.session(python=SUPPORTED_PYTHONS, tags=["test"])
 @nox.parametrize("sphinx", SUPPORTED_SPHINX_VERSIONS)
 def test(session, sphinx):
     """Run tests with different Python and Sphinx versions."""
@@ -56,23 +56,45 @@ def test(session, sphinx):
     session.run("pytest")
 
 
-@nox.session(python=SUPPORTED_PYTHONS[-1:])  # Use the last Python version
+@nox.session(tags=["lint"])
 def mypy(session: nox.Session) -> None:
     """Run mypy."""
     install_dependencies(session)
     session.run("mypy", "sphinx_reredirects")
 
 
-@nox.session(python=SUPPORTED_PYTHONS[-1:])  # Use the last Python version
+@nox.session(tags=["lint"])
 def ruff_check(session: nox.Session) -> None:
     """Run Ruff check."""
-    install_dependencies(session)
+    install_dependencies(session, "--only-dev")
     session.run("ruff", "check")
 
 
-@nox.session(python=SUPPORTED_PYTHONS[-1:])  # Use the last Python version
-def build(session: nox.Session) -> None:
-    """Build the package."""
-    install_dependencies(session)
-    session.run("rm", "-rf", "dist", external=True)
-    session.run("flit", "build")
+@nox.session()
+def publish_to_test_pypi(session: nox.Session) -> None:
+    """Build and publish the package to test PyPI. You will be asked for token. See `docs/releasing.md` for full instructions."""
+    install_dependencies(session, "--only-dev")
+
+    session.run(
+        "flit",
+        "publish",
+        env={
+            "FLIT_INDEX_URL": "https://test.pypi.org/legacy/",
+            "FLIT_USERNAME": "__token__",
+        },
+    )
+
+
+@nox.session()
+def publish_to_real_pypi(session: nox.Session) -> None:
+    """Build and publish the package to real PyPI. You will be asked for token. See `docs/releasing.md` for full instructions."""
+    install_dependencies(session, "--only-dev")
+
+    session.run(
+        "flit",
+        "publish",
+        env={
+            "FLIT_INDEX_URL": "https://pypi.org/legacy/",
+            "FLIT_USERNAME": "__token__",
+        },
+    )

pyproject.toml

@@ -8,7 +8,7 @@ maintainers = [
 ]
 requires-python = ">=3.11"
 dependencies = [
-    "sphinx>=7.4,<9.0"
+    "sphinx>=7.4,<9.0",
 ]
 classifiers = [
     "Framework :: Sphinx :: Extension",
@@ -31,12 +31,11 @@ repository = "https://github.com/documatt/sphinx-reredirects"
 
 [dependency-groups]
 dev = [
-    "flit>=3.12.0",
-    "mypy>=1.16.0",
-    "nox>=2025.5.1",
-    "pytest>=8.3.5",
-    "ruff>=0.11.12",
-    "twine>=6.1.0",
+    "flit==3.12.0",
+    "mypy==1.16.0",
+    "nox==2025.5.1",
+    "pytest==8.3.5",
+    "ruff==0.11.12",
 ]
 
 [build-system]

releasing.md

@@ -0,0 +1,40 @@
+# How to release new version
+
+## Part 1: Git release
+
+1. Choose a version value. git-cliff also calculate new version number based on Git history.
+
+1. Create branch `release/v<version>`.
+
+1. Update `CHANGELOG.md`. Either manually or with git-cliff tool (e.g., `git-cliff --prepend CHANGELOG.md --bump --unreleased`)
+
+1. Fine tune `CHANGELOG.md`. Reorder, fix typos, reword, etc.
+
+1. Set new version to `__version__` variable in `<package>/__init__.py`.
+
+1. Create "release commit" containing changes to `<package>/__init__.py` with message `chore: release vX.Y.Z`. Release commit may contain other changes too, like to `CHANGELOG.md` and so on.
+
+1. Create PR for branch. Wait for tests, linters. Do a code review. Merge to main branch.
+
+1. Create tag `vX.Y.Z` on release commit.
+
+   ```sh
+   git tag -a vX.Y.Z
+   git push origin HEAD
+   ```
+
+## Part 2: PyPI release
+
+1. Upload to TestPyPI.
+
+   ```sh
+   uv run nox -s publish_to_test_pypi
+   ```
+
+   and go to https://test.pypi.org/project/sphinx-reredirects/<version>/
+
+1. If you are happy with it, upload to real PyPI.
+
+   ```sh
+   uv run nox -s publish_to_real_pypi
+   ```