feat: programmatic access to library's version

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>

Author: jkowalleck

cyclonedx/__init__.py

@@ -17,3 +17,7 @@
 """
 Python library for generating and representing CycloneDX software bill-of-materials.
 """
+
+# !! version is managed by semantic_release
+# do not use typing here, or else `semantic_release` might have issues finding the variable
+__version__ = "4.1.0-alpha.1"

cyclonedx/model/__init__.py

@@ -17,7 +17,6 @@
 
 import hashlib
 import re
-import sys
 import warnings
 from datetime import datetime, timezone
 from enum import Enum
@@ -26,6 +25,7 @@
 import serializable
 from sortedcontainers import SortedSet
 
+from .. import __version__ as __ThisToolVersion
 from ..exception.model import (
     InvalidLocaleTypeException,
     InvalidUriException,
@@ -1394,15 +1394,6 @@ def __repr__(self) -> str:
         return f'<Copyright text={self.text}>'
 
 
-if sys.version_info >= (3, 8):
-    from importlib.metadata import version as meta_version
-else:
-    from importlib_metadata import version as meta_version
-
-try:
-    __ThisToolVersion: Optional[str] = str(meta_version('cyclonedx-python-lib'))  # type: ignore[no-untyped-call]
-except Exception:
-    __ThisToolVersion = None
 ThisTool = Tool(vendor='CycloneDX', name='cyclonedx-python-lib', version=__ThisToolVersion or 'UNKNOWN')
 ThisTool.external_references.update([
     ExternalReference(

docs/conf.py

@@ -22,7 +22,8 @@
 author = 'Paul Horton, Jan Kowalleck, Steve Springett, Patrick Dwyer'
 
 # The full version, including alpha/beta/rc tags
-release = pkg_resources.get_distribution("cyclonedx-python-lib").version
+# !! version is managed by semantic_release
+release = '4.1.0-alpha.1'
 
 # -- General configuration ---------------------------------------------------
 

pyproject.toml

@@ -4,7 +4,8 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "cyclonedx-python-lib"
-version = "4.0.1"
+# !! version is managed by semantic_release
+version = "4.1.0-alpha.1"
 description = "A library for producing CycloneDX SBOM (Software Bill of Materials) files."
 authors = ["Paul Horton <phorton@sonatype.com>"]
 maintainers = [
@@ -76,6 +77,10 @@ commit_message = "chore(release): {version}\n\nAutomatically generated by python
 upload_to_vcs_release = true
 build_command = "pip install poetry && poetry build"
 version_toml = ["pyproject.toml:tool.poetry.version"]
+version_variables = [
+  "cyclonedx/__init__.py:__version__",
+  "docs/conf.py:release",
+]
 [tool.semantic_release.changelog]
 changelog_file = "CHANGELOG.md"
 exclude_commit_patterns = [