Add script for infering version from pyproject.toml

Author: dolfinus

CHANGELOG.rst

@@ -4,6 +4,14 @@ Changelog
 1.10
 ----
 
+.. changelog::
+    :version: 1.10.1
+
+    .. change::
+        :tags: core, feature
+
+        Add ``setuptools-git-versioning`` script to infer version from ``pyproject.toml`` config
+
 .. changelog::
     :version: 1.10.0
     :released: 18.07.2022

README.rst

@@ -85,6 +85,17 @@ Just add ``setuptools-git-versioning`` to ``build-sytem`` part of your ``pyproje
     [tool.setuptools-git-versioning]
     enabled = true
 
+And check the package version generated:
+
+.. code:: bash
+    $ python -m setuptools_git_versioning
+    0.0.1
+
+    # or
+
+    $ setuptools-git-versioning
+    0.0.1
+
 ``setup.py``
 ~~~~~~~~~~~~~~
 
@@ -101,3 +112,9 @@ Just add ``setuptools-git-versioning`` to ``setup_requires`` part of your ``setu
         },
         setup_requires=["setuptools-git-versioning"],
     )
+
+And check the package version generated:
+
+.. code:: bash
+    $ python setup.py --version
+    0.0.1

setup.py

@@ -58,6 +58,7 @@ def parse_requirements(file_content):
         "setuptools.finalize_distribution_options": [
             "setuptools_git_versioning = setuptools_git_versioning:infer_version",
         ],
+        "console_scripts": ["setuptools-git-versioning=setuptools_git_versioning:__main__"],
     },
     include_package_data=True,
     zip_safe=False,

setuptools_git_versioning.py

@@ -5,15 +5,18 @@
 import os
 import re
 import subprocess
+import textwrap
 import warnings
 from collections.abc import Mapping
 from datetime import datetime
-from distutils.errors import DistutilsSetupError
 from pathlib import Path
-from typing import Any, Callable
+from typing import TYPE_CHECKING, Any, Callable
 
 from setuptools.dist import Distribution
 
+if TYPE_CHECKING:
+    from packaging.version import Version
+
 DEFAULT_TEMPLATE = "{tag}"
 DEFAULT_DEV_TEMPLATE = "{tag}.post{ccount}+git.{sha}"
 DEFAULT_DIRTY_TEMPLATE = "{tag}.post{ccount}+git.{sha}.dirty"
@@ -146,6 +149,8 @@ def read_toml(file_name: str | os.PathLike) -> dict:
 
 # TODO: remove along with version_config
 def parse_config(dist: Distribution, attr: Any, value: Any) -> None:
+    from distutils.errors import DistutilsOptionError
+
     if attr == "version_config" and value is not None:
         warnings.warn(
             "`version_config` option is deprecated "
@@ -156,14 +161,16 @@ def parse_config(dist: Distribution, attr: Any, value: Any) -> None:
         )
 
         if getattr(dist, "setuptools_git_versioning", None) is not None:
-            raise DistutilsSetupError(
+            raise DistutilsOptionError(
                 "You can set either `version_config` or `setuptools_git_versioning` "
                 "but not both of them at the same time"
             )
 
 
 # real version is generated here
 def infer_version(dist: Distribution) -> None:
+    from distutils.errors import DistutilsOptionError, DistutilsSetupError
+
     value = getattr(dist, "setuptools_git_versioning", None) or getattr(dist, "version_config", None)
 
     if isinstance(value, bool):
@@ -190,7 +197,7 @@ def infer_version(dist: Distribution) -> None:
         return
 
     if not isinstance(value, Mapping):
-        raise DistutilsSetupError(f"Wrong config format. Expected dict, got: {value}")
+        raise DistutilsOptionError(f"Wrong config format. Expected dict, got: {value}")
 
     if not value or not value.get("enabled", True):
         # Nothing to do here
@@ -439,3 +446,35 @@ def version_from_git(
     local_sanitized = LOCAL_REGEXP.sub(".", local)
     public_sanitized = VERSION_PREFIX_REGEXP.sub("", public)  # for version "v1.0.0" drop leading "v" symbol
     return public_sanitized + sep + local_sanitized
+
+
+def main(config: dict | None = None) -> Version:
+    value = config or read_toml("pyproject.toml")
+
+    if not value or not value.get("enabled", True):
+        raise RuntimeError(
+            textwrap.dedent(
+                """
+                'setuptools-git-versioning' command can be used only with 'pyproject.toml'
+                file setup (see https://setuptools-git-versioning.readthedocs.io/en/stable/install.html)
+                """,
+            ),
+        )
+
+    if not isinstance(value, Mapping):
+        raise RuntimeError(f"Wrong config format. Expected dict, got: {value}")
+
+    config = load_config_from_dict(value)
+    result = version_from_git(**config)
+
+    from packaging.version import Version
+
+    return Version(result)
+
+
+def __main__():
+    print(main().public)
+
+
+if __name__ == "__main__":
+    __main__()

tests/lib/util.py

@@ -256,6 +256,14 @@ def get_version_setup_py(cwd, **kwargs):  # type: (str, **Any) -> str
     return execute(cwd, f"{sys.executable} setup.py --version", **kwargs).strip()
 
 
+def get_version_module(cwd, **kwargs):  # type: (str, **Any) -> str
+    return execute(cwd, f"{sys.executable} -m setuptools_git_versioning", **kwargs).strip()
+
+
+def get_version_script(cwd, **kwargs):  # type: (str, **Any) -> str
+    return execute(cwd, "setuptools-git-versioning", **kwargs).strip()
+
+
 def get_version(cwd, isolated=False, **kwargs):  # type: (str, bool, **Any) -> str
     cmd = f"{sys.executable} -m build -s"
     if not isolated:

tests/test_integration/test_command.py

@@ -0,0 +1,31 @@
+import pytest
+import subprocess
+
+from tests.lib.util import get_version_script, get_version_module, create_pyproject_toml, create_setup_py
+
+
+def test_command_pyproject_toml(repo):
+    create_pyproject_toml(repo)
+
+    assert get_version_module(repo) == "0.0.1"
+    assert get_version_script(repo) == "0.0.1"
+
+
+def test_command_pyproject_toml_disabled(repo):
+    create_pyproject_toml(repo, {"enabled": False})
+
+    with pytest.raises(subprocess.CalledProcessError):
+        get_version_module(repo)
+
+    with pytest.raises(subprocess.CalledProcessError):
+        get_version_script(repo)
+
+
+def test_command_setup_py_fail(repo):
+    create_setup_py(repo)
+
+    with pytest.raises(subprocess.CalledProcessError):
+        get_version_module(repo)
+
+    with pytest.raises(subprocess.CalledProcessError):
+        get_version_script(repo)