Local and distribution versioning

Author: deadmanoz

pyproject.toml

@@ -59,5 +59,5 @@ include = ["warnet*", "test_framework*", "resources*"]
 
 [tool.setuptools_scm]
 write_to = "src/warnet/_version.py"
-version_scheme = "guess-next-dev"
-local_scheme = "dirty-tag"
+# Note: Custom version scheme is handled in setup.py
+fallback_version = "0.0.0"

setup.py

@@ -0,0 +1,64 @@
+import subprocess
+
+from setuptools import setup
+
+
+def version(version) -> str:
+    """
+    Format the version string.
+    This function is called by setuptools_scm to determine the distribution version.
+    """
+    # Use base_version if available, otherwise fall back to a default
+    if hasattr(version, "base_version") and version.base_version:
+        vers = version.base_version
+    elif hasattr(version, "tag") and version.tag:
+        # If we have a tag but no base_version, try to extract from tag
+        vers = str(version.tag).lstrip("v")
+    else:
+        # Default fallback version if nothing else is available
+        vers = "0.0.0"
+
+    return vers
+
+
+def local_version(version) -> str:
+    """
+    Format the local version using the git hash and status of the working directory.
+    If all succeeds, the returned string will be something like "63fe5aa1-dirty"
+    This function is called by setuptools_scm to determine the local version part.
+    """
+    suffix = ""
+
+    try:
+        # Get the short git hash
+        result = subprocess.run(
+            ["git", "rev-parse", "--short=8", "HEAD"], capture_output=True, text=True, check=True
+        )
+        commit = result.stdout.strip()
+
+        if commit:
+            suffix = f"{commit}"
+
+            # Check if working directory is dirty
+            status_result = subprocess.run(
+                ["git", "status", "--porcelain"], capture_output=True, text=True, check=True
+            )
+
+            if status_result.stdout.strip():
+                suffix += "-dirty"
+    except (subprocess.SubprocessError, FileNotFoundError):
+        # Ignore errors from git commands
+        pass
+
+    return suffix
+
+
+# Using setuptools_scm with custom version functions
+setup(
+    use_scm_version={
+        "version_scheme": version,
+        "local_scheme": local_version,
+        "fallback_version": "0.0.0",
+        "relative_to": __file__,
+    }
+)

src/warnet/main.py

@@ -1,3 +1,5 @@
+import subprocess
+
 import click
 
 from .admin import admin
@@ -21,12 +23,59 @@ def cli():
 @click.command()
 def version() -> None:
     """Display the installed version of warnet"""
+    # Try to get dynamic version from the Git repository
+    # This allows a developer to get up-to-date version information
+    # depending on the state of their local git repository
+    # (e.g. when installed from source in editable mode).
+    try:
+        # Check if we're in a git repository
+        subprocess.check_output(
+            ["git", "rev-parse", "--is-inside-work-tree"], stderr=subprocess.DEVNULL
+        )
+
+        # Get the base version from the latest tag
+        try:
+            tag = (
+                subprocess.check_output(
+                    ["git", "describe", "--tags", "--abbrev=0"],
+                    stderr=subprocess.DEVNULL,
+                    text=True,
+                )
+                .strip()
+                .lstrip("v")
+            )
+        except subprocess.SubprocessError:
+            # No tags found
+            tag = "0.0.0"
+
+        # Get the short commit hash
+        commit = subprocess.check_output(
+            ["git", "rev-parse", "--short=8", "HEAD"], stderr=subprocess.DEVNULL, text=True
+        ).strip()
+
+        # Check if there are uncommitted changes
+        status = subprocess.check_output(
+            ["git", "status", "--porcelain"], stderr=subprocess.DEVNULL, text=True
+        ).strip()
+
+        # Format the version string to match setup.py
+        version_str = tag
+        if commit:
+            version_str += f".{commit}"
+            if status:
+                version_str += "-dirty"
+
+        click.echo(f"warnet version {version_str} (from git)")
+        return
+    except (subprocess.SubprocessError, FileNotFoundError):
+        # Git commands failed or git not available, fall back to installed version
+        pass
+
+    # Fall back to the version file generated during installation
     try:
         from warnet._version import __version__
 
         version = __version__
-        # If running from source/git, setuptools_scm will append git info
-        # e.g. "1.1.11.dev1+g123456[.dirty]"
         click.echo(f"warnet version {version}")
     except ImportError:
         click.echo("warnet version unknown")