Merge pull request #120 from the-scouts/scm-versioning

.github/workflows/linting.yml

@@ -30,7 +30,7 @@ jobs:
             deps: "bandit"
           # packaging (CheeseShop) compliance
           - tool: "pyroma"
-            command: "pyroma ."
+            command: "python ci/pyroma-version-fixer.py && pyroma ."
             deps: "pyroma"
           # type checking
           - tool: "mypy"

ci/pyroma-version-fixer.py

@@ -0,0 +1,11 @@
+from pathlib import Path
+
+Path(__file__, "..", "version.txt").resolve().write_text(
+    # read version file
+    Path(__file__, "..", "..", "compass", "core", "__version__.py").resolve().read_text(encoding="utf-8")
+    # get first line
+    .split("\n")[0]
+    # remove lead and tail
+    .removeprefix('__version__ = "').removesuffix('"'),
+    encoding="utf-8",
+)

compass/core/__init__.py

@@ -5,6 +5,8 @@
 from __future__ import annotations
 
 from compass.core import logger
+from compass.core.__version__ import __version__
+from compass.core.__version__ import __version_info__
 from compass.core.errors import CompassAuthenticationError
 from compass.core.errors import CompassError
 from compass.core.errors import CompassNetworkError
@@ -63,6 +65,9 @@ def login(username: str, password: str, /, *, role: str | None = None, location:
 
 
 __all__ = (
+    # public metadata
+    "__version__",
+    "__version_info__",
     # public sub-modules
     "logger",
     # public classes

compass/core/__version__.py

@@ -0,0 +1,2 @@
+__version__ = "0.20.0"
+__version_info__ = (0, 20, 0)

environment.yml

@@ -35,7 +35,7 @@ dependencies:
   - pep8-naming
   - pydocstyle
   - bandit
-  - pyroma
+#  - pyroma (outdated on CF as at 2021-09-24)
   - mypy
   - lxml-stubs
 
@@ -45,3 +45,6 @@ dependencies:
   - pip:
     # Type validation
     - phonenumberslite
+
+    # Linting
+    - pyroma

pyproject.toml

@@ -1,8 +1,15 @@
 # Build system requirements.
 [build-system]
-requires = ["setuptools>=41.0", "wheel"]  #"setuptools-scm",
+requires = ["setuptools>=45.0", "wheel", "setuptools-scm>=6.2"]
 build-backend = "setuptools.build_meta"
 
+[tool.setuptools_scm]
+write_to = "compass/core/__version__.py"
+write_to_template = """\
+__version__ = "{version}"
+__version_info__ = {version_tuple}
+"""
+
 # Black configuration
 [tool.black]
 line-length = 132  # 120*1.1

setup.cfg

@@ -1,8 +1,9 @@
 # setuptools metadata
 [metadata]
 name = compass-interface-core
-version = 0.20.0
-# version = attr: src.VERSION
+# this is only needed for pyroma linting and is generated by `ci/pyroma-version-fixer.py`
+# the actual package version is set by setuptools-scm
+version = file: ci/version.txt
 description = The unofficial API to the TSA Compass membership database
 long_description = file: README.md
 long_description_content_type = text/markdown