Project metadata: Add versioning based on Git tags, using versioningit

Author: amotl

.bumpversion.cfg

@@ -1,7 +1,9 @@
 *
+!.git
 !etc
 !mqttwarn
 !tests
+!pyproject.toml
 !setup.py
 !MANIFEST.in
 !*.ini

.dockerignore

@@ -61,7 +61,7 @@ jobs:
     - name: Setup project
       run: |
         # Install package in editable mode.
-        pip install wheel
+        pip install versioningit wheel
         pip install --editable=.[test,develop]
 
     - name: Check code style

.github/workflows/tests.yml

@@ -7,6 +7,10 @@ in progress
 ===========
 
 - Modernize Docker configuration, now using Debian bullseye and Python 3.11.
+- Improve nightly and on-PR Docker builds.
+- Add versioning based on Git tags, using ``versioningit``. This will aid in
+  telling PR- and nightly releases apart from GA releases when running
+  ``mqttwarn --version``.
 
 
 2022-11-21 0.31.0

CHANGES.rst

@@ -7,6 +7,9 @@
 #
 FROM python:3.11-slim-bullseye
 
+# Install additional requirements
+RUN apt-get update && apt-get install --yes git
+
 # Create /etc/mqttwarn
 RUN mkdir -p /etc/mqttwarn
 WORKDIR /etc/mqttwarn
@@ -17,7 +20,7 @@ RUN chown -R mqttwarn:mqttwarn /etc/mqttwarn
 
 # Install mqttwarn
 COPY . /src
-RUN pip install wheel
+RUN pip install versioningit wheel
 RUN pip install /src
 
 # Make process run as "mqttwarn" user

Dockerfile

@@ -8,6 +8,8 @@
 FROM python:3.11-slim-bullseye
 
 # Install additional requirements
+RUN apt-get update && apt-get install --yes git
+
 # FIXME: Skip all packages needing compilation
 #RUN apt-get update && apt-get install --yes librrd-dev
 
@@ -21,7 +23,7 @@ RUN chown -R mqttwarn:mqttwarn /etc/mqttwarn
 
 # Install mqttwarn
 COPY . /src
-RUN pip install wheel
+RUN pip install versioningit wheel
 RUN pip install /src[all]
 
 # Make process run as "mqttwarn" user

Dockerfile.full

@@ -11,7 +11,7 @@ $(eval venvpath     := .venv)
 $(eval pip          := $(venvpath)/bin/pip)
 $(eval python       := $(venvpath)/bin/python)
 $(eval pytest       := $(venvpath)/bin/pytest)
-$(eval bumpversion  := $(venvpath)/bin/bumpversion)
+$(eval minibump     := $(venvpath)/bin/minibump)
 $(eval twine        := $(venvpath)/bin/twine)
 $(eval sphinx       := $(venvpath)/bin/sphinx-build)
 $(eval isort        := $(venvpath)/bin/isort)
@@ -21,6 +21,7 @@ $(eval poe          := $(venvpath)/bin/poe)
 # Setup Python virtualenv
 setup-virtualenv:
 	@test -e $(python) || python3 -m venv $(venvpath)
+	$(pip) install versioningit
 
 
 # -------
@@ -71,7 +72,7 @@ docs-html: install-doctools
 # Utility targets
 # ===============
 bumpversion: install-releasetools
-	@$(bumpversion) $(bump)
+	@$(minibump) bump --relax $(bump)
 
 push:
 	git push && git push --tags

Makefile

@@ -1,8 +1,13 @@
 # -*- coding: utf-8 -*-
-# (c) 2014-2018 The mqttwarn developers
-
-__version__ = "0.31.0"
+# (c) 2014-2023 The mqttwarn developers
 
 __author__ = "Jan-Piet Mens <jpmens()gmail.com>, Ben Jones <ben.jones12()gmail.com>"
 __copyright__ = "Copyright 2014-2022 Jan-Piet Mens"
 __license__ = "Eclipse Public License - v 2.0 (http://www.eclipse.org/legal/epl-2.0/)"
+
+try:
+    from importlib.metadata import version
+except ImportError:
+    from importlib_metadata import version  # type: ignore[no-redef]
+
+__version__ = version("mqttwarn")

mqttwarn/__init__.py

@@ -1,3 +1,22 @@
+# ==================
+# Build system setup
+# ==================
+
+[build-system]
+requires = [
+    "setuptools>=42",  # At least v42 of setuptools required!
+    "versioningit",
+]
+build-backend = "setuptools.build_meta"
+
+
+[tool.versioningit]
+
+[tool.versioningit.vcs]
+method = "git"
+default-tag = "0.0.0"
+
+
 # =========================
 # Linter and code formatter
 # =========================

pyproject.toml

@@ -1,3 +1,3 @@
-bump2version
+minibump<1; python_version>='3.10'
 twine
 keyring