Document how to make a release and use real version in apiService

docs/release.md

@@ -0,0 +1,20 @@
+# How to make a PyHSS release
+
+* Create a pull request with a release commit containing the following:
+  * `lib/version.py`: update `pyhss_version`
+  * `CHANGELOG.md`:
+    * Replace `## [Unreleased]` with the new version number and date in this
+      format: `## [1.0.1] - 2024-01-23`
+    * Add a new line at the bottom of the document linking to the future tag.
+  * `debian/changelog`:
+    * Run `gbp dch --ignore-branch` to update it with a list of commits since
+      the file was last changed.
+    * Adjust the first line in `debian/changelog`:
+      * Adjust the version number.
+      * Change `UNRELEASED` to `unstable`.
+
+* After the PR is merged:
+  * `git tag NEWRELEASEVERSION`
+  * `git push origin NEWRELEASEVERSION`
+
+* Add a new `## [Unreleased]` section in `CHANGELOG.md`

lib/version.py

@@ -0,0 +1,4 @@
+# Copyright 2026 sysmocom - s.f.m.c. GmbH <info@sysmocom.de>
+# SPDX-License-Identifier: AGPL-3.0-or-later
+
+pyhss_version = "1.0.2"

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyhss"
-version = "1.0.2"
+dynamic = ["version"]
 requires-python = ">=3.11"
 
 [project.scripts]
@@ -27,6 +27,9 @@ packages = [
 	"pyhss.tools",
 ]
 
+[tool.setuptools.dynamic]
+version = {attr = "pyhss.lib.version.pyhss_version"}
+
 [tool.setuptools.package-dir]
 pyhss = ""
 
@@ -63,6 +66,7 @@ include = [
 	"lib/gsup/controller/ss.py",
 	"lib/gsup/protocol/gsup_msg.py",
 	"lib/pyhss_config.py",
+	"lib/version.py",
 	"tests/test_database_upgrade_mariadb.py",
 	"tests/test_database_upgrade_postgresql.py",
 	"tests/test_database_upgrade_sqlite.py",

services/apiService.py

@@ -24,6 +24,7 @@
 from diameter import Diameter
 from messaging import RedisMessaging
 from baseModels import SubscriberInfo
+from version import pyhss_version
 import database
 from pyhss_config import config
 
@@ -81,9 +82,12 @@
 
 
 apiService.wsgi_app = ProxyFix(apiService.wsgi_app)
-api = Api(apiService, version='1.0', title=f'{siteName + " - " if siteName else ""}{originHostname} - PyHSS OAM API',
-    description='Restful API for working with PyHSS',
-    doc='/docs/'
+api = Api(
+    apiService,
+    version=pyhss_version,
+    title=f"{siteName + ' - ' if siteName else ''}{originHostname} - PyHSS OAM API",
+    description="Restful API for working with PyHSS",
+    doc="/docs/",
 )
 
 ns_apn = api.namespace('apn', description='PyHSS APN Functions')