Derive package version from git tag via setuptools-scm

.git_archival.txt

@@ -0,0 +1,4 @@
+node: $Format:%H$
+node-date: $Format:%cI$
+describe-name: $Format:%(describe:tags=true,match=*[0-9]*)$
+ref-names: $Format:%D$

.gitattributes

@@ -0,0 +1 @@
+.git_archival.txt  export-subst

.github/workflows/on-release-main.yml

@@ -5,55 +5,28 @@ on:
     types: [published]
 
 jobs:
-  set-version:
-    runs-on: ubuntu-24.04
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Export tag
-        id: vars
-        run: echo tag=${GITHUB_REF#refs/*/} >> $GITHUB_OUTPUT
-        if: ${{ github.event_name == 'release' }}
-
-      - name: Update project version
-        run: |
-          sed -i "s/^version = \".*\"/version = \"$RELEASE_VERSION\"/" pyproject.toml
-          sed -i "s/__version__ .*/__version__ = \"$RELEASE_VERSION\"/" flask_cors/version.py
-
-        env:
-          RELEASE_VERSION: ${{ steps.vars.outputs.tag }}
-        if: ${{ github.event_name == 'release' }}
-
-      - name: Upload updated pyproject.toml
-        uses: actions/upload-artifact@v4
-        with:
-          name: pyproject-toml
-          path: |
-            pyproject.toml
-            flask_cors/version.py
-
   publish:
     runs-on: ubuntu-latest
     environment: release
     permissions:
       id-token: write # this permission is mandatory for trusted publishing
-    needs: [set-version]
     steps:
       - name: Check out
         uses: actions/checkout@v4
+        with:
+          # Fetch the full history and all tags so that setuptools-scm can
+          # derive the version from the released git tag.
+          fetch-depth: 0
 
       - name: Set up the environment
         uses: ./.github/actions/setup-python-env
 
-      - name: Download updated pyproject.toml
-        uses: actions/download-artifact@v4
-        with:
-          name: pyproject-toml
-      - name: Cat files
-        run: cat pyproject.toml && cat flask_cors/version.py
       - name: Build package
         run: uv build
 
+      - name: Show built artifacts
+        run: ls -l dist/
+
       - name: Publish package
         run: uv publish --trusted-publishing always
 

flask_cors/__init__.py

@@ -1,6 +1,12 @@
+from importlib.metadata import PackageNotFoundError, version
+
 from .decorator import cross_origin
 from .extension import CORS
-from .version import __version__
+
+try:
+    __version__ = version("flask-cors")
+except PackageNotFoundError:  # pragma: no cover - package is not installed
+    __version__ = "unknown"
 
 __all__ = ["CORS", "__version__", "cross_origin"]
 

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "flask-cors"
-version = "0.0.1"
+dynamic = ["version"]
 description = "A Flask extension simplifying CORS support"
 authors = [{ name = "Cory Dolphin", email = "corydolphin@gmail.com" }]
 readme = "README.rst"
@@ -43,9 +43,17 @@ dev = [
 ]
 
 [build-system]
-requires = ["setuptools"]
+requires = ["setuptools>=64", "setuptools-scm>=8"]
 build-backend = "setuptools.build_meta"
 
+[tool.setuptools_scm]
+# The version is derived from the latest git tag. For source archives
+# generated by GitHub (`git archive`), the version is recovered from the
+# substituted values in .git_archival.txt (see .gitattributes export-subst).
+# fallback_version is only used when building outside of a git checkout and
+# without archival metadata.
+fallback_version = "0.0.0"
+
 [tool.setuptools]
 packages = ["flask_cors"]
 # This is a workaround for https://github.com/astral-sh/uv/issues/9513