Switch versioning to be SCM-based (#715)

Co-authored-by: Abhinav Singh <mailsforabhinav@gmail.com>

.dockerignore

@@ -2,6 +2,7 @@
 **
 
 # Except proxy
+!.git
 !proxy
 !requirements.txt
 !pyproject.toml

.github/workflows/test-docker.yml

@@ -45,6 +45,7 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         pip install -r requirements.txt
+        pip install -r requirements-release.txt
         pip install -r requirements-testing.txt
         pip install -r requirements-tunnel.txt
     - name: Build

.pre-commit-config.yaml

@@ -163,6 +163,7 @@ repos:
     additional_dependencies:
     - paramiko == 2.8.0
     - types-paramiko == 2.7.3
+    - types-setuptools == 57.4.2
     args:
     # FIXME: get rid of missing imports ignore
     - --ignore-missing-imports

Dockerfile

@@ -1,6 +1,9 @@
 FROM python:3.10-alpine as base
+RUN apk add git
+
 FROM base as builder
 
+COPY .git /app/.git
 COPY requirements.txt /app/
 COPY pyproject.toml /app/
 COPY setup.cfg /app/

Makefile

@@ -2,7 +2,8 @@ SHELL := /bin/bash
 
 NS ?= abhinavsingh
 IMAGE_NAME ?= proxy.py
-VERSION ?= v$(shell python -m proxy --version)
+#VERSION ?= v$(shell bash -c "python -m setuptools_scm --version \| awk '{print$3}'")
+VERSION ?= v$(shell python -m setuptools_scm --version | awk '{print $$3}' | sed 's/\+/--/')
 LATEST_TAG := $(NS)/$(IMAGE_NAME):latest
 IMAGE_TAG := $(NS)/$(IMAGE_NAME):$(VERSION)
 

proxy/common/.gitignore

@@ -0,0 +1,2 @@
+# Build-time setuptools-scm generated version module
+/_scm_version.py

proxy/common/_scm_version.pyi

@@ -0,0 +1,3 @@
+# This stub file is necessary because `_scm_version.py`
+# autogenerated on build and absent on mypy checks time
+version: str

proxy/common/_version.py

@@ -0,0 +1,11 @@
+"""Version definition."""
+
+try:
+    # pylint: disable=unused-import
+    from ._scm_version import version as __version__  # noqa: WPS433, WPS436
+except ImportError:
+    from pkg_resources import get_distribution as _get_dist  # noqa: WPS433
+    __version__ = _get_dist('proxy.py').version  # noqa: WPS440
+
+
+__all__ = ('__version__',)

proxy/common/version.py

@@ -8,5 +8,24 @@
     :copyright: (c) 2013-present by Abhinav Singh and contributors.
     :license: BSD, see LICENSE for more details.
 """
-VERSION = (2, 4, 0)
-__version__ = '.'.join(map(str, VERSION[0:3]))
+from typing import Tuple, Union
+
+from ._version import __version__  # noqa: WPS436
+
+
+def _to_int_or_str(inp: str) -> Union[int, str]:
+    try:
+        return int(inp)
+    except ValueError:
+        return inp
+
+
+def _split_version_parts(inp: str) -> Tuple[str, ...]:
+    public_version, _plus, local_version = inp.partition('+')
+    return (*public_version.split('.'), local_version)
+
+
+VERSION = tuple(map(_to_int_or_str, _split_version_parts(__version__)))
+
+
+__all__ = '__version__', 'VERSION'

pyproject.toml

@@ -2,5 +2,12 @@
 requires = [
   # Essentials
   "setuptools",
+
+  # Plugins
+  "setuptools-scm[toml] >= 6",
+  "setuptools-scm-git-archive >= 1.1",
 ]
 build-backend = "setuptools.build_meta"
+
+[tool.setuptools_scm]
+write_to = "proxy/common/_scm_version.py"

requirements-release.txt

@@ -1 +1,2 @@
-twine==3.5.0
+setuptools-scm == 6.3.2
+twine==3.5.0