setuptools-git-versioning 1.13.5__tar.gz → 2.0.0__tar.gz

{setuptools-git-versioning-1.13.5/setuptools_git_versioning.egg-info → setuptools-git-versioning-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: setuptools-git-versioning
-Version: 1.13.5
+Version: 2.0.0
 Summary: Use git repo data for building a version number according PEP-440
 Home-page: https://setuptools-git-versioning.readthedocs.io
 Author: dolfinus
@@ -20,11 +20,15 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.7
 Description-Content-Type: text/x-rst
 License-File: LICENSE
+Requires-Dist: packaging
+Requires-Dist: setuptools
+Requires-Dist: toml>=0.10.2; python_version < "3.11"
 
 *************************
 setuptools-git-versioning
@@ -68,14 +72,16 @@ version number according :pep:`440`.
 
 - Well-documented
 
-See `difference <https://setuptools-git-versioning.readthedocs.io/en/latest/differences.html>`_
+See `comparison <https://setuptools-git-versioning.readthedocs.io/en/stable/comparison.html>`_
 between ``setuptools-git-versioning`` and other tools.
 
 **Limitations:**
 
 - Currently the only supported VCS is *Git*
 
-- Only git v2 is supported
+- Only Git v2 is supported
+
+- Only Setuptools build backend is supported (no Poetry & others)
 
 - Currently does not support automatic exporting of package version to a file for runtime use
   (but you can use ``setuptools-git-versioning > file`` redirect instead)
@@ -109,7 +115,7 @@ add a section ``tool.setuptools-git-versioning`` with config options, and mark t
 .. code:: toml
 
     [build-system]
-    requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning<2", ]
+    requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=2.0,<3", ]
     build-backend = "setuptools.build_meta"
 
     [tool.setuptools-git-versioning]
@@ -118,7 +124,7 @@ add a section ``tool.setuptools-git-versioning`` with config options, and mark t
     [project]
     dynamic = ["version"]
 
-And check the package version generated (see `command help <https://setuptools-git-versioning.readthedocs.io/en/stable/command.html>`__):
+And check the package version generated (see `command help <https://setuptools-git-versioning.readthedocs.io/en/stable/command.html>`_):
 
 .. code:: bash
 
@@ -131,7 +137,7 @@ And check the package version generated (see `command help <https://setuptools-g
     0.0.1
 
 ``setup.py``
-~~~~~~~~~~~~~~
+~~~~~~~~~~~~
 
 Just add ``setuptools-git-versioning`` to ``setup_requires`` argument of ``setuptools.setup`` function call,
 and then add new argument ``setuptools_git_versioning`` with config options:
@@ -145,10 +151,10 @@ and then add new argument ``setuptools_git_versioning`` with config options:
         setuptools_git_versioning={
             "enabled": True,
         },
-        setup_requires=["setuptools-git-versioning<2"],
+        setup_requires=["setuptools-git-versioning>=2.0,<3"],
     )
 
-And check the package version generated (see `command help <https://setuptools-git-versioning.readthedocs.io/en/stable/command.html>`__):
+And check the package version generated (see `command help <https://setuptools-git-versioning.readthedocs.io/en/stable/command.html>`_):
 
 .. code:: bash
 

{setuptools-git-versioning-1.13.5 → setuptools-git-versioning-2.0.0}/README.rst

@@ -40,14 +40,16 @@ version number according :pep:`440`.
 
 - Well-documented
 
-See `difference <https://setuptools-git-versioning.readthedocs.io/en/latest/differences.html>`_
+See `comparison <https://setuptools-git-versioning.readthedocs.io/en/stable/comparison.html>`_
 between ``setuptools-git-versioning`` and other tools.
 
 **Limitations:**
 
 - Currently the only supported VCS is *Git*
 
-- Only git v2 is supported
+- Only Git v2 is supported
+
+- Only Setuptools build backend is supported (no Poetry & others)
 
 - Currently does not support automatic exporting of package version to a file for runtime use
   (but you can use ``setuptools-git-versioning > file`` redirect instead)
@@ -81,7 +83,7 @@ add a section ``tool.setuptools-git-versioning`` with config options, and mark t
 .. code:: toml
 
     [build-system]
-    requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning<2", ]
+    requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=2.0,<3", ]
     build-backend = "setuptools.build_meta"
 
     [tool.setuptools-git-versioning]
@@ -90,7 +92,7 @@ add a section ``tool.setuptools-git-versioning`` with config options, and mark t
     [project]
     dynamic = ["version"]
 
-And check the package version generated (see `command help <https://setuptools-git-versioning.readthedocs.io/en/stable/command.html>`__):
+And check the package version generated (see `command help <https://setuptools-git-versioning.readthedocs.io/en/stable/command.html>`_):
 
 .. code:: bash
 
@@ -103,7 +105,7 @@ And check the package version generated (see `command help <https://setuptools-g
     0.0.1
 
 ``setup.py``
-~~~~~~~~~~~~~~
+~~~~~~~~~~~~
 
 Just add ``setuptools-git-versioning`` to ``setup_requires`` argument of ``setuptools.setup`` function call,
 and then add new argument ``setuptools_git_versioning`` with config options:
@@ -117,10 +119,10 @@ and then add new argument ``setuptools_git_versioning`` with config options:
         setuptools_git_versioning={
             "enabled": True,
         },
-        setup_requires=["setuptools-git-versioning<2"],
+        setup_requires=["setuptools-git-versioning>=2.0,<3"],
     )
 
-And check the package version generated (see `command help <https://setuptools-git-versioning.readthedocs.io/en/stable/command.html>`__):
+And check the package version generated (see `command help <https://setuptools-git-versioning.readthedocs.io/en/stable/command.html>`_):
 
 .. code:: bash
 

{setuptools-git-versioning-1.13.5 → setuptools-git-versioning-2.0.0}/setup.py

@@ -19,7 +19,7 @@ setup(
     name="setuptools-git-versioning",
     # +local version is not allowed in PyPI
     # https://github.com/pypa/pypi-legacy/issues/731#issuecomment-345461596
-    version='1.13.5',
+    version='2.0.0',
     author="dolfinus",
     author_email="martinov.m.s.8@gmail.com",
     description="Use git repo data for building a version number according PEP-440",
@@ -38,6 +38,7 @@ setup(
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
         "License :: OSI Approved :: MIT License",
         "Operating System :: OS Independent",
     ],
@@ -54,8 +55,7 @@ setup(
     setup_requires=requirements,
     entry_points={
         "distutils.setup_keywords": [
-            "version_config = setuptools_git_versioning:_parse_config",
-            "setuptools_git_versioning = setuptools_git_versioning:_parse_config",
+            "setuptools_git_versioning = setuptools_git_versioning:parse_config",
         ],
         "setuptools.finalize_distribution_options": [
             "setuptools_git_versioning = setuptools_git_versioning:infer_version",

{setuptools-git-versioning-1.13.5 → setuptools-git-versioning-2.0.0/setuptools_git_versioning.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: setuptools-git-versioning
-Version: 1.13.5
+Version: 2.0.0
 Summary: Use git repo data for building a version number according PEP-440
 Home-page: https://setuptools-git-versioning.readthedocs.io
 Author: dolfinus
@@ -20,11 +20,15 @@ Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.7
 Description-Content-Type: text/x-rst
 License-File: LICENSE
+Requires-Dist: packaging
+Requires-Dist: setuptools
+Requires-Dist: toml>=0.10.2; python_version < "3.11"
 
 *************************
 setuptools-git-versioning
@@ -68,14 +72,16 @@ version number according :pep:`440`.
 
 - Well-documented
 
-See `difference <https://setuptools-git-versioning.readthedocs.io/en/latest/differences.html>`_
+See `comparison <https://setuptools-git-versioning.readthedocs.io/en/stable/comparison.html>`_
 between ``setuptools-git-versioning`` and other tools.
 
 **Limitations:**
 
 - Currently the only supported VCS is *Git*
 
-- Only git v2 is supported
+- Only Git v2 is supported
+
+- Only Setuptools build backend is supported (no Poetry & others)
 
 - Currently does not support automatic exporting of package version to a file for runtime use
   (but you can use ``setuptools-git-versioning > file`` redirect instead)
@@ -109,7 +115,7 @@ add a section ``tool.setuptools-git-versioning`` with config options, and mark t
 .. code:: toml
 
     [build-system]
-    requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning<2", ]
+    requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=2.0,<3", ]
     build-backend = "setuptools.build_meta"
 
     [tool.setuptools-git-versioning]
@@ -118,7 +124,7 @@ add a section ``tool.setuptools-git-versioning`` with config options, and mark t
     [project]
     dynamic = ["version"]
 
-And check the package version generated (see `command help <https://setuptools-git-versioning.readthedocs.io/en/stable/command.html>`__):
+And check the package version generated (see `command help <https://setuptools-git-versioning.readthedocs.io/en/stable/command.html>`_):
 
 .. code:: bash
 
@@ -131,7 +137,7 @@ And check the package version generated (see `command help <https://setuptools-g
     0.0.1
 
 ``setup.py``
-~~~~~~~~~~~~~~
+~~~~~~~~~~~~
 
 Just add ``setuptools-git-versioning`` to ``setup_requires`` argument of ``setuptools.setup`` function call,
 and then add new argument ``setuptools_git_versioning`` with config options:
@@ -145,10 +151,10 @@ and then add new argument ``setuptools_git_versioning`` with config options:
         setuptools_git_versioning={
             "enabled": True,
         },
-        setup_requires=["setuptools-git-versioning<2"],
+        setup_requires=["setuptools-git-versioning>=2.0,<3"],
     )
 
-And check the package version generated (see `command help <https://setuptools-git-versioning.readthedocs.io/en/stable/command.html>`__):
+And check the package version generated (see `command help <https://setuptools-git-versioning.readthedocs.io/en/stable/command.html>`_):
 
 .. code:: bash
 

{setuptools-git-versioning-1.13.5 → setuptools-git-versioning-2.0.0}/setuptools_git_versioning.egg-info/entry_points.txt

@@ -2,8 +2,7 @@
 setuptools-git-versioning = setuptools_git_versioning:__main__
 
 [distutils.setup_keywords]
-setuptools_git_versioning = setuptools_git_versioning:_parse_config
-version_config = setuptools_git_versioning:_parse_config
+setuptools_git_versioning = setuptools_git_versioning:parse_config
 
 [setuptools.finalize_distribution_options]
 setuptools_git_versioning = setuptools_git_versioning:infer_version

{setuptools-git-versioning-1.13.5 → setuptools-git-versioning-2.0.0}/setuptools_git_versioning.py

@@ -9,7 +9,6 @@ import re
 import subprocess  # nosec
 import sys
 import textwrap
-import warnings
 from datetime import datetime
 from pathlib import Path
 from pprint import pformat
@@ -104,18 +103,6 @@ def get_all_tags(sort_by: str = DEFAULT_SORT_BY, root: str | os.PathLike | None
     return []
 
 
-def get_branch_tags(*args, **kwargs) -> list[str]:
-    warnings.warn(
-        "`get_branch_tags` function is deprecated "
-        "since setuptools-git-versioning v1.8.0 "
-        "and will be dropped in v2.0.0\n"
-        "Please use `get_tags` instead",
-        category=UserWarning,
-    )
-
-    return get_tags(*args, **kwargs)
-
-
 def get_tags(
     sort_by: str = DEFAULT_SORT_BY,
     filter_callback: Callable[[str], str | None] | None = None,
@@ -188,7 +175,7 @@ def _read_toml(name_or_path: str | os.PathLike = "pyproject.toml", root: str | o
 
     log.log(INFO, "Trying 'pyproject.toml' ...")
     try:
-        # for Python 3.11
+        # for Python 3.11+
         import tomllib
 
         with file_path.open("rb") as file:
@@ -232,24 +219,9 @@ def _infer_setup_py(name_or_path: str = "setup.py", root: str | os.PathLike | No
         os.chdir(original_cwd)
 
 
-# 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 "
-            "since setuptools-git-versioning v1.8.0 "
-            "and will be dropped in v2.0.0\n"
-            "Please rename it to 'setuptools_git_versioning'",
-            category=UserWarning,
-        )
-
-        if getattr(dist, "setuptools_git_versioning", None) is not None:
-            raise DistutilsOptionError(
-                "You can set either 'version_config' or 'setuptools_git_versioning' "
-                "but not both of them at the same time"
-            )
+def parse_config(dist: Distribution, attr: Any, value: Any) -> None:
+    "Dummy function used only to register in distutils"
+    return None
 
 
 def infer_version(dist: Distribution, root: str | os.PathLike | None = None) -> str | None:
@@ -257,18 +229,7 @@ def infer_version(dist: Distribution, root: str | os.PathLike | None = None) ->
 
     from distutils.errors import DistutilsOptionError, DistutilsSetupError
 
-    config = getattr(dist, "setuptools_git_versioning", None) or getattr(dist, "version_config", None)
-
-    if isinstance(config, bool):
-        warnings.warn(
-            "Passing boolean value to 'version_config'/'setuptools_git_versioning' option is deprecated "
-            "since setuptools-git-versioning 1.8.0 "
-            "and will be dropped in v2.0.0\n"
-            "Please change value to '{'enabled': False/True}'",
-            category=UserWarning,
-        )
-        config = {"enabled": config}
-
+    config = getattr(dist, "setuptools_git_versioning", None)
     toml_config = _read_toml(root=root)
 
     if config is None:
@@ -450,12 +411,12 @@ def _callable_factory(
     try:
         return _load_callable(regexp_or_ref, package_name, root=root)
     except (ImportError, NameError) as e:
-        log.warning("%s is not a valid function reference: %s", callable_name, e)
+        log.log(DEBUG, "%s is not a valid function reference: %s", callable_name, e)
 
     try:
         return callable_factory(regexp_or_ref)
     except re.error as e:
-        log.error("%s is not valid regexp: %s", callable_name, e)
+        log.error("%s is not valid regexp neither a valid function reference: %s", callable_name, e)
         raise ValueError(f"Cannot parse {callable_name}") from e
 
 
@@ -545,6 +506,9 @@ def version_from_git(
             )
         return _get_version_from_callback(version_callback, package_name, root=root)
 
+    head_sha = get_sha(root=root)
+    log.log(INFO, "HEAD SHA-256: %r", head_sha)
+
     filter_callback = None
     if tag_filter:
         filter_callback = _callable_factory(
@@ -555,16 +519,22 @@ def version_from_git(
             root=root,
         )
 
-    from_file = False
     log.log(INFO, "Getting latest tag")
     log.log(DEBUG, "Sorting tags by %r", sort_by)
     tag = get_tag(sort_by=sort_by, root=root, filter_callback=filter_callback)
+    if not tag:
+        log.log(INFO, "No tags found")
+        tag_sha = None
+        on_tag = False
+    else:
+        tag_sha = get_sha(tag, root=root)
+        log.log(INFO, "Tag SHA-256: %r", tag_sha)
+
+        on_tag = head_sha is not None and head_sha == tag_sha
+        log.log(INFO, "HEAD is tagged: %r", on_tag)
 
-    if tag is None:
-        log.log(INFO, "No tag, checking for 'version_file'")
-        if version_file is None:
-            log.log(INFO, "No 'version_file' set, return starting_version %r", starting_version)
-            return _sanitize_version(starting_version)
+    if version_file:
+        log.log(INFO, "Checking for 'version_file'")
 
         if not Path(version_file).exists():
             log.log(
@@ -573,26 +543,30 @@ def version_from_git(
                 version_file,
                 starting_version,
             )
-            return _sanitize_version(starting_version)
+            tag = None
+        else:
+            log.log(INFO, "Reading version_file '%s' content", version_file)
+            tag = _read_version_from_file(version_file, root=root) or None
+
+            if not tag:
+                log.log(INFO, "File %r is empty", version_file)
+            else:
+                log.log(DEBUG, "File content: %r", tag)
+                if not count_commits_from_version_file:
+                    return _sanitize_version(tag)
 
-        log.log(INFO, "version_file '%s' does exist, reading its content", version_file)
-        from_file = True
-        tag = _read_version_from_file(version_file, root=root)
+                file_sha = get_latest_file_commit(version_file, root=root)
+                log.log(DEBUG, "File SHA-256: %r", file_sha)
 
-        if not tag:
-            log.log(INFO, "File is empty, return starting_version %r", version_file, starting_version)
-            return _sanitize_version(starting_version)
+                ccount = count_since(file_sha, root=root) if file_sha is not None else None
+                log.log(INFO, "Commits count between HEAD and last version file change: %r", ccount)
 
-        log.log(DEBUG, "File content: %r", tag)
-        if not count_commits_from_version_file:
-            return _sanitize_version(tag)
+    elif not head_sha:
+        log.log(INFO, "Not a git repo, or repo without any branch")
 
-        tag_sha = get_latest_file_commit(version_file, root=root)
-        log.log(DEBUG, "File SHA-256: %r", tag_sha)
-    else:
-        log.log(INFO, "Latest tag: %r", tag)
-        tag_sha = get_sha(tag, root=root)
-        log.log(INFO, "Tag SHA-256: %r", tag_sha)
+    elif tag_sha:
+        ccount = count_since(tag_sha, root=root)
+        log.log(INFO, "Commits count between HEAD and last tag: %r", ccount)
 
         if tag_formatter is not None:
             tag_format_callback = _callable_factory(
@@ -606,19 +580,13 @@ def version_from_git(
             tag = tag_format_callback(tag)
             log.log(DEBUG, "Tag after formatting: %r", tag)
 
+    if not tag:
+        log.log(INFO, "No source for version, return starting_version %r", starting_version)
+        return _sanitize_version(starting_version)
+
     dirty = is_dirty(root=root)
     log.log(INFO, "Is dirty: %r", dirty)
 
-    head_sha = get_sha(root=root)
-    log.log(INFO, "HEAD SHA-256: %r", head_sha)
-
-    full_sha = head_sha if head_sha is not None else ""
-    ccount = count_since(tag_sha, root=root) if tag_sha is not None else None
-    log.log(INFO, "Commits count between HEAD and latest tag: %r", ccount)
-
-    on_tag = head_sha is not None and head_sha == tag_sha and not from_file
-    log.log(INFO, "HEAD is tagged: %r", on_tag)
-
     branch = get_branch(root=root)
     log.log(INFO, "Current branch: %r", branch)
 
@@ -644,6 +612,7 @@ def version_from_git(
         log.log(INFO, "Using template from 'template' option")
         t = template
 
+    full_sha = head_sha if head_sha is not None else ""
     version = _resolve_substitutions(t, sha=full_sha[:8], tag=tag, ccount=ccount, branch=branch, full_sha=full_sha)
     log.log(INFO, "Version number after resolving substitutions: %r", version)
     return _sanitize_version(version)