Add miniver to simplify development branch descriptions

.github/workflows/ci.yml

@@ -23,6 +23,9 @@ jobs:
       fail-fast: false
     steps:
     - uses: actions/checkout@v3
+      with:
+        # https://github.com/actions/checkout#fetch-all-history-for-all-tags-and-branches
+        fetch-depth: 0
     - name: Set up Python 3.9
       uses: actions/setup-python@v4
       with:
@@ -42,6 +45,9 @@ jobs:
       fail-fast: false
     steps:
     - uses: actions/checkout@v3
+      with:
+        # https://github.com/actions/checkout#fetch-all-history-for-all-tags-and-branches
+        fetch-depth: 0
     - name: Set up Python 3.9
       uses: actions/setup-python@v4
       with:
@@ -80,6 +86,9 @@ jobs:
             pyversion: '3.11'
     steps:
     - uses: actions/checkout@v3
+      with:
+        # https://github.com/actions/checkout#fetch-all-history-for-all-tags-and-branches
+        fetch-depth: 0
     - name: Set up Python ${{ matrix.pyversion }}
       uses: actions/setup-python@v4
       with:
@@ -103,6 +112,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
+      with:
+        # https://github.com/actions/checkout#fetch-all-history-for-all-tags-and-branches
+        fetch-depth: 0
     - name: Set up Python 3.9
       uses: actions/setup-python@v4
       with:
@@ -113,7 +125,7 @@ jobs:
         pip install .[dev]
     - name: Unit tests
       run: |
-        pytest -v pygfx/__pyinstaller
+        pytest -vx pygfx/__pyinstaller
 
   test-examples-build:
     name: Test examples
@@ -122,6 +134,9 @@ jobs:
       fail-fast: false
     steps:
     - uses: actions/checkout@v3
+      with:
+        # https://github.com/actions/checkout#fetch-all-history-for-all-tags-and-branches
+        fetch-depth: 0
     - name: Set up Python 3.9
       uses: actions/setup-python@v4
       with:
@@ -155,6 +170,9 @@ jobs:
       fail-fast: false
     steps:
       - uses: actions/checkout@v3
+        with:
+          # https://github.com/actions/checkout#fetch-all-history-for-all-tags-and-branches
+          fetch-depth: 0
       - name: Set up Python 3.9
         uses: actions/setup-python@v4
         with:
@@ -194,6 +212,9 @@ jobs:
     if: success() && startsWith(github.ref, 'refs/tags/v')
     steps:
     - uses: actions/checkout@v3
+      with:
+        # https://github.com/actions/checkout#fetch-all-history-for-all-tags-and-branches
+        fetch-depth: 0
     - name: Set up Python 3.9
       uses: actions/setup-python@v4
       with:

.github/workflows/screenshots.yml

@@ -16,6 +16,9 @@ jobs:
     runs-on: 'ubuntu-latest'
     steps:
     - uses: actions/checkout@v3
+      with:
+        # https://github.com/actions/checkout#fetch-all-history-for-all-tags-and-branches
+        fetch-depth: 0
     - name: Set up Python 3.9
       uses: actions/setup-python@v4
       with:

pygfx/__init__.py

@@ -25,8 +25,9 @@
 
 del pylinalg
 
-__version__ = "0.1.18"
-version_info = tuple(map(int, __version__.split(".")))
+from ._version import __version__
+
+version_info = tuple(map(int, __version__.split(".")[:3]))
 
 __wgpu_version_range__ = "0.14.1", "0.16.0"
 __pylinalg_version_range__ = "0.4.1", "0.5.0"

pygfx/_version.py

@@ -0,0 +1,130 @@
+# -*- coding: utf-8 -*-
+# This file is part of 'miniver': https://github.com/jbweston/miniver
+#
+from collections import namedtuple
+import os
+
+Version = namedtuple("Version", ("release", "post", "labels"))
+
+# No public API
+__all__ = []
+
+package_root = os.path.dirname(os.path.realpath(__file__))
+package_name = os.path.basename(package_root)
+STATIC_VERSION_FILE = "_static_version.py"
+
+
+def get_version():
+    version = get_version_from_git()
+    if not version:
+        version = Version("unknown", None, None)
+    return pep440_format(version)
+
+
+def pep440_format(version_info):
+    release, post, labels = version_info
+
+    version_parts = [release]
+    if post:
+        if release.endswith("-post") or release.endswith(".post"):
+            version_parts.append(post)
+        else:  # prefer PEP440 over strict adhesion to semver
+            version_parts.append(".post{}".format(post))
+
+    if labels:
+        version_parts.append("+")
+        version_parts.append(".".join(labels))
+
+    return "".join(version_parts)
+
+
+def get_version_from_git():
+    import subprocess
+
+    # git describe --first-parent does not take into account tags from branches
+    # that were merged-in. The '--long' flag gets us the 'post' version and
+    # git hash, '--always' returns the git hash even if there are no tags.
+    for opts in [["--first-parent"], []]:
+        try:
+            p = subprocess.Popen(
+                ["git", "describe", "--long", "--always", "--tags", "--dirty"] + opts,
+                cwd=package_root,
+                stdout=subprocess.PIPE,
+                stderr=subprocess.PIPE,
+            )
+        except OSError:
+            return
+        if p.wait() == 0:
+            break
+    else:
+        return
+
+    description = (
+        p.communicate()[0]
+        .decode()
+        .lstrip("v")  # Tags can have a leading 'v', but the version should not
+        .rstrip("\n")
+        .rsplit("-")  # Split the latest tag, commits since tag, and hash, and dirty
+    )
+
+    try:
+        release, post, git = description[:3]
+    except ValueError:  # No tags, only the git hash
+        # prepend 'g' to match with format returned by 'git describe'
+        git = "g{}".format(*description)
+        release = "nodescription"
+        post = None
+
+    labels = []
+    if post == "0":
+        post = None
+    else:
+        labels.append(git)
+
+    if description[-1] == "dirty":
+        labels.append("dirty")
+
+    return Version(release, post, labels)
+
+
+__version__ = get_version()
+
+
+# The following section defines a 'get_cmdclass' function
+# that can be used from setup.py. The '__version__' module
+# global is used (but not modified).
+
+
+def _write_version(fname):
+    # This could be a hard link, so try to delete it first.  Is there any way
+    # to do this atomically together with opening?
+    try:
+        os.remove(fname)
+    except OSError:
+        pass
+    with open(fname, "w") as f:
+        f.write(f"__version__ = '{__version__}'")
+
+
+def get_cmdclass(pkg_source_path):
+    from setuptools.command.build_py import build_py as build_py_orig
+    from setuptools.command.sdist import sdist as sdist_orig
+
+    class _build_py(build_py_orig):  # noqa
+        def run(self):
+            super().run()
+
+            src_marker = "".join(["src", os.path.sep])
+
+            if pkg_source_path.startswith(src_marker):
+                path = pkg_source_path[len(src_marker) :]
+            else:
+                path = pkg_source_path
+            _write_version(os.path.join(self.build_lib, path, "_version.py"))
+
+    class _sdist(sdist_orig):  # noqa
+        def make_release_tree(self, base_dir, files):
+            super().make_release_tree(base_dir, files)
+            _write_version(os.path.join(base_dir, pkg_source_path, "_version.py"))
+
+    return dict(sdist=_sdist, build_py=_build_py)

setup.py

@@ -3,9 +3,24 @@
 from setuptools import find_packages, setup
 
 
+def get_version_and_cmdclass():
+    """Load version.py module without importing the whole package.
+
+    Template code from miniver
+    """
+    import os
+    from importlib.util import module_from_spec, spec_from_file_location
+
+    spec = spec_from_file_location("version", os.path.join("pygfx", "_version.py"))
+    module = module_from_spec(spec)
+    spec.loader.exec_module(module)
+    return module.__version__, getattr(module, "get_cmdclass", lambda x: {})("pygfx")
+
+
+version, cmdclass = get_version_and_cmdclass()
+
 with open("pygfx/__init__.py", "rb") as fh:
     init_text = fh.read().decode()
-    VERSION = re.search(r"__version__ = \"(.*?)\"", init_text).group(1)
     match = re.search(r"__wgpu_version_range__ = \"(.*?)\", \"(.*?)\"", init_text)
     wgpu_min_ver, wgpu_max_ver = match.group(1), match.group(2)
     match = re.search(r"__pylinalg_version_range__ = \"(.*?)\", \"(.*?)\"", init_text)
@@ -65,7 +80,8 @@
 
 setup(
     name="pygfx",
-    version=VERSION,
+    version=version,
+    cmdclass=cmdclass,
     packages=find_packages(
         exclude=["tests", "tests.*", "examples", "examples.*", "exp", "exp.*"]
     ),