Merge pull request #59 from cortex-lab/agent/development-version

Mark master as 2.7.1.dev0

Author: rossant

CHANGELOG.md

@@ -10,6 +10,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Code of Conduct for project participation and incident reporting.
 
+### Fixed
+- Development checkouts now report a development version with a Git commit suffix.
+
 ## [2.7.0] 2025-12-10
 
 ### Added

README.md

@@ -9,9 +9,14 @@ Electrophysiological data analysis library used by [phy](https://github.com/kwik
 
 - participation in phylib is governed by the project [Code of Conduct](CODE_OF_CONDUCT.md)
 - run all tests using pytest `pytest phylib`
-- PR to main
-- update `CHANGELOG.md` and version in `phylib\__init__.py`
-- publish to pypi:
+- PR to master
+- keep `phylib/__init__.py` on the next development version (for example,
+  `2.7.1.dev0`)
+- for a release, update `CHANGELOG.md`, remove the `.dev0` suffix, run the
+  tests, and tag the exact release commit
+- after publishing, immediately bump `phylib/__init__.py` to the next
+  `.dev0` version
+- publish to pypi:
 ```shell
 rm -R dist
 rm -R build 

phylib/__init__.py

@@ -22,7 +22,7 @@
 
 __author__ = 'Cyrille Rossant'
 __email__ = 'cyrille.rossant at gmail.com'
-__version__ = '2.7.0'
+__version__ = '2.7.1.dev0'
 __version_git__ = __version__ + _git_version()
 
 

phylib/utils/_misc.py

@@ -354,19 +354,19 @@ def _load_from_fullname(name):
 
 
 def _git_version():
-    """Return the git version."""
-    curdir = os.getcwd()
-    os.chdir(str(Path(__file__).parent))
+    """Return a PEP 440-compatible local version derived from Git."""
+    cwd = str(Path(__file__).parent)
     try:
         with open(os.devnull, 'w') as fnull:
-            version = ('-git-' + subprocess.check_output(
-                       ['git', 'describe', '--abbrev=8', '--dirty', '--always', '--tags'],
-                       stderr=fnull).strip().decode('ascii'))
-            return version
+            revision = subprocess.check_output(
+                ['git', 'rev-parse', '--short=8', 'HEAD'],
+                cwd=cwd, stderr=fnull).strip().decode('ascii')
+            dirty = subprocess.call(
+                ['git', 'diff', '--quiet', 'HEAD', '--'],
+                cwd=cwd, stdout=fnull, stderr=fnull)
+            return '+git.' + revision + ('.dirty' if dirty else '')
     except (OSError, subprocess.CalledProcessError):  # pragma: no cover
         return ""
-    finally:
-        os.chdir(curdir)
 
 
 def phy_config_dir():

phylib/utils/tests/test_misc.py

@@ -6,6 +6,8 @@
 # Imports
 #------------------------------------------------------------------------------
 
+import re
+
 import numpy as np
 from numpy.testing import assert_array_equal as ae
 from pytest import raises, mark
@@ -137,7 +139,7 @@ def test_write_tsv(tempdir):
 
 def test_git_version():
     v = _git_version()
-    assert v
+    assert re.match(r'^\+git\.[0-9a-f]{8}(?:\.dirty)?$', v)
 
 
 def _myfunction(x):

phylib/utils/tests/test_version.py

@@ -0,0 +1,21 @@
+# -*- coding: utf-8 -*-
+
+"""Tests of package versioning."""
+
+import re
+import subprocess
+import sys
+from pathlib import Path
+
+import phylib
+
+
+def test_version_format():
+    assert re.match(r'^\d+\.\d+\.\d+(?:\.dev\d+)?$', phylib.__version__)
+
+
+def test_setup_version_matches_package_version():
+    root = Path(__file__).parents[3]
+    version = subprocess.check_output(
+        [sys.executable, 'setup.py', '--version'], cwd=str(root)).decode().strip()
+    assert version == phylib.__version__