Re-introduce setuptools-scm with correct usage (#206)

Author: aMahanna

.github/workflows/pypi.yaml

@@ -16,7 +16,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install setuptools wheel twine
+        pip install setuptools wheel twine setuptools-scm[toml]
     - name: Build distribution
       run: python setup.py sdist bdist_wheel
     - name: Publish to PyPI Test
@@ -28,4 +28,4 @@ jobs:
       env:
         TWINE_USERNAME: __token__
         TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
-      run: twine upload --repository pypi dist/*
+      run: twine upload --repository pypi dist/*

.gitignore

@@ -118,3 +118,6 @@ node_modules/
 # direnv
 .envrc
 .direnv/
+
+# setuptools_scm
+arango/version.py

arango/client.py

@@ -3,6 +3,8 @@
 from json import dumps, loads
 from typing import Any, Callable, Optional, Sequence, Union
 
+from pkg_resources import get_distribution
+
 from arango.connection import (
     BasicConnection,
     Connection,
@@ -18,7 +20,6 @@
     RoundRobinHostResolver,
     SingleHostResolver,
 )
-from arango.version import version
 
 
 class ArangoClient:
@@ -113,6 +114,7 @@ def version(self) -> str:
         :return: Client version.
         :rtype: str
         """
+        version: str = get_distribution("python-arango").version
         return version
 
     def db(

arango/version.py

@@ -1,6 +1,7 @@
 [build-system]
 requires = [
     "setuptools>=42",
+    "setuptools_scm[toml]>=6.2",
     "wheel",
 ]
 build-backend = "setuptools.build_meta"
@@ -25,3 +26,6 @@ warn_return_any = true
 warn_unused_configs = true
 ignore_missing_imports = true
 strict = true
+
+[tool.setuptools_scm]
+write_to = "arango/version.py"

pyproject.toml

@@ -3,16 +3,11 @@
 with open("./README.md") as fp:
     long_description = fp.read()
 
-version = {}
-with open("./arango/version.py") as fp:
-    exec(fp.read(), version)
-
 setup(
     name="python-arango",
     description="Python Driver for ArangoDB",
     long_description=long_description,
     long_description_content_type="text/markdown",
-    version=version["version"],
     author="Joohwan Oh",
     author_email="[email protected]",
     url="https://github.com/ArangoDB-Community/python-arango",
@@ -43,6 +38,7 @@
             "sphinx_rtd_theme",
             "types-pkg_resources",
             "types-requests",
+            "types-setuptools",
         ],
     },
     classifiers=[