Merge pull request 'chore: migrate from pbr to setuptools-scm for dynamic versioning' (#6) from chore/setuptools-scm into master

Reviewed-on: http://git.hemna.com/hemna/aprsd-twitter-plugin/pulls/6

aprsd_twitter_plugin/__init__.py

@@ -1,15 +1,6 @@
-# Licensed under the Apache License, Version 2.0 (the "License"); you may
-# not use this file except in compliance with the License. You may obtain
-# a copy of the License at
-#
-#      http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
-# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
-# License for the specific language governing permissions and limitations
-# under the License.
+from importlib.metadata import PackageNotFoundError, version
 
-import pbr.version
-
-__version__ = pbr.version.VersionInfo("aprsd_twitter_plugin").version_string()
+try:
+    __version__ = version("aprsd_twitter_plugin")
+except PackageNotFoundError:
+    __version__ = "unknown"

pyproject.toml

@@ -1,10 +1,10 @@
 [build-system]
-requires = ["setuptools>=61.0", "wheel", "pbr"]
+requires = ["setuptools>=61.0", "wheel", "setuptools-scm"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name = "aprsd_twitter_plugin"
-version = "0.0.0"  # Version managed by pbr
+dynamic = ["version"]
 description = "Python APRSD plugin to send tweets"
 readme = "README.rst"
 requires-python = ">=3.11"
@@ -20,7 +20,6 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
 ]
 dependencies = [
-    "pbr",
     "tweepy",
     "oslo.config",
 ]
@@ -29,7 +28,6 @@ dependencies = [
 dev = [
     "pip",
     "pip-tools",
-    "bump2version",
     "wheel",
     "watchdog",
     "ruff",
@@ -39,7 +37,7 @@ dev = [
     "Sphinx",
     "twine",
     "pytest",
-    "gray",
+    "aprsd",
 ]
 
 [tool.setuptools]
@@ -57,8 +55,8 @@ packages = ["aprsd_twitter_plugin"]
 [project.scripts]
     "aprsd-twitter-plugin-export-config" = "aprsd_twitter_plugin.cli:main"
 
-[tool.pbr]
-# PBR configuration
+[tool.setuptools_scm]
+# version is derived from git tags (e.g. v1.0.0 -> 1.0.0)
 
 [tool.mypy]
 ignore_missing_imports = true

tests/test_aprsd_twitter_plugin.py

@@ -6,9 +6,27 @@ from unittest.mock import MagicMock, patch
 
 import pytest
 
+import aprsd_twitter_plugin
 from aprsd_twitter_plugin.twitter import SendTweetPlugin
 
 
+class TestVersion:
+    """Tests for package version metadata."""
+
+    def test_version_is_set(self):
+        """__version__ must be a non-empty string."""
+        assert isinstance(aprsd_twitter_plugin.__version__, str)
+        assert len(aprsd_twitter_plugin.__version__) > 0
+
+    def test_version_not_unknown(self):
+        """Version must not be 'unknown' when installed via pip install -e ."""
+        # When installed with setuptools-scm and a git tag the version is
+        # derived from the tag.  'unknown' means the package could not be found
+        # in the metadata at all — that should never happen for an editable
+        # install.
+        assert aprsd_twitter_plugin.__version__ != "unknown"
+
+
 @pytest.fixture
 def mock_conf():
     """Create a mock configuration object."""