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

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

@@ -1,11 +1,10 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: setuptools-git-versioning
-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
-Author-email: martinov.m.s.8@gmail.com
+Version: 3.0.0
+Summary: Use git repo data for building a version number according to PEP-440
+Author-email: dolfinus <martinov.m.s.8@gmail.com>
 License: MIT
+Project-URL: Homepage, https://setuptools-git-versioning.readthedocs.io
 Project-URL: Documentation, https://setuptools-git-versioning.readthedocs.io
 Project-URL: Source, https://github.com/dolfinus/setuptools-git-versioning
 Project-URL: CI/CD, https://github.com/dolfinus/setuptools-git-versioning/actions
@@ -21,14 +20,15 @@ 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: Programming Language :: Python :: 3.13
 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"
+Requires-Dist: tomli>=2.0.1; python_version < "3.11"
+Dynamic: license-file
 
 *************************
 setuptools-git-versioning
@@ -56,7 +56,7 @@ setuptools-git-versioning
     :target: https://results.pre-commit.ci/latest/github/dolfinus/setuptools-git-versioning/master
 
 Use git repo data (latest tag, current commit hash, etc) for building a
-version number according :pep:`440`.
+version number according to :pep:`440`.
 
 **Features:**
 
@@ -115,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.0,<3", ]
+    requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=3.0,<4", ]
     build-backend = "setuptools.build_meta"
 
     [tool.setuptools-git-versioning]
@@ -136,6 +136,31 @@ And check the package version generated (see `command help <https://setuptools-g
     $ setuptools-git-versioning
     0.0.1
 
+When add a git tag:
+
+.. code:: bash
+
+    $ git add .
+    $ git commit -m "Test tagged"
+    $ git tag 1.2.3
+
+And now version is based on git tag:
+
+.. code:: bash
+
+    $ setuptools-git-versioning
+    1.2.3
+
+    $ echo 1 > uncommitted.change
+    $ git add .
+    $ setuptools-git-versioning
+    1.2.3.post0+git.d2bc6516.dirty
+
+    $ git commit -m "Test committed"
+    $ setuptools-git-versioning
+    1.2.3.post1+git.d452190b
+
+
 ``setup.py``
 ~~~~~~~~~~~~
 
@@ -151,22 +176,7 @@ and then add new argument ``setuptools_git_versioning`` with config options:
         setuptools_git_versioning={
             "enabled": True,
         },
-        setup_requires=["setuptools-git-versioning>=2.0,<3"],
+        setup_requires=["setuptools-git-versioning>=3.0,<4"],
     )
 
-And check the package version generated (see `command help <https://setuptools-git-versioning.readthedocs.io/en/stable/command.html>`_):
-
-.. code:: bash
-
-    $ python setup.py --version
-    0.0.1
-
-    # or
-
-    $ python -m setuptools_git_versioning
-    0.0.1
-
-    # or
-
-    $ setuptools-git-versioning
-    0.0.1
+Commands are the same as above, plus ``python -m setup.py`` returns the same version.

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

@@ -24,7 +24,7 @@ setuptools-git-versioning
     :target: https://results.pre-commit.ci/latest/github/dolfinus/setuptools-git-versioning/master
 
 Use git repo data (latest tag, current commit hash, etc) for building a
-version number according :pep:`440`.
+version number according to :pep:`440`.
 
 **Features:**
 
@@ -83,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.0,<3", ]
+    requires = [ "setuptools>=41", "wheel", "setuptools-git-versioning>=3.0,<4", ]
     build-backend = "setuptools.build_meta"
 
     [tool.setuptools-git-versioning]
@@ -104,6 +104,31 @@ And check the package version generated (see `command help <https://setuptools-g
     $ setuptools-git-versioning
     0.0.1
 
+When add a git tag:
+
+.. code:: bash
+
+    $ git add .
+    $ git commit -m "Test tagged"
+    $ git tag 1.2.3
+
+And now version is based on git tag:
+
+.. code:: bash
+
+    $ setuptools-git-versioning
+    1.2.3
+
+    $ echo 1 > uncommitted.change
+    $ git add .
+    $ setuptools-git-versioning
+    1.2.3.post0+git.d2bc6516.dirty
+
+    $ git commit -m "Test committed"
+    $ setuptools-git-versioning
+    1.2.3.post1+git.d452190b
+
+
 ``setup.py``
 ~~~~~~~~~~~~
 
@@ -119,22 +144,7 @@ and then add new argument ``setuptools_git_versioning`` with config options:
         setuptools_git_versioning={
             "enabled": True,
         },
-        setup_requires=["setuptools-git-versioning>=2.0,<3"],
+        setup_requires=["setuptools-git-versioning>=3.0,<4"],
     )
 
-And check the package version generated (see `command help <https://setuptools-git-versioning.readthedocs.io/en/stable/command.html>`_):
-
-.. code:: bash
-
-    $ python setup.py --version
-    0.0.1
-
-    # or
-
-    $ python -m setuptools_git_versioning
-    0.0.1
-
-    # or
-
-    $ setuptools-git-versioning
-    0.0.1
+Commands are the same as above, plus ``python -m setup.py`` returns the same version.

setuptools_git_versioning-3.0.0/pyproject.toml

@@ -0,0 +1,174 @@
+[build-system]
+requires = [
+    "packaging",
+    "setuptools",
+    'tomli>=2.0.1; python_version<"3.11"',
+    "wheel",
+]
+build-backend = "setuptools.build_meta:__legacy__"
+
+[project]
+name = "setuptools-git-versioning"
+version = "3.0.0"
+authors = [{name = "dolfinus", email = "martinov.m.s.8@gmail.com"}]
+license = {text = "MIT"}
+description = "Use git repo data for building a version number according to PEP-440"
+keywords = ["setuptools", "git", "versioning", "pep-440"]
+classifiers = [
+    "Framework :: Setuptools Plugin",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Operating System :: OS Independent",
+]
+requires-python = ">=3.7"
+dependencies = [
+    "packaging",
+    "setuptools",
+    'tomli>=2.0.1; python_version<"3.11"',
+]
+
+[project.readme]
+file = "README.rst"
+content-type = "text/x-rst"
+
+[project.urls]
+Homepage = "https://setuptools-git-versioning.readthedocs.io"
+Documentation = "https://setuptools-git-versioning.readthedocs.io"
+Source = "https://github.com/dolfinus/setuptools-git-versioning"
+"CI/CD" = "https://github.com/dolfinus/setuptools-git-versioning/actions"
+Coverage = "https://app.codecov.io/gh/dolfinus/setuptools-git-versioning"
+Tracker = "https://github.com/dolfinus/setuptools-git-versioning/issues"
+
+[project.entry-points."distutils.setup_keywords"]
+setuptools_git_versioning = "setuptools_git_versioning:parse_config"
+
+[project.entry-points."setuptools.finalize_distribution_options"]
+setuptools_git_versioning = "setuptools_git_versioning:infer_version"
+
+[project.entry-points."console_scripts"]
+setuptools-git-versioning = "setuptools_git_versioning.cli:main"
+
+[tool.setuptools.packages.find]
+include = ["setuptools_git_versioning*"]
+exclude = ["docs*", "tests*"]
+
+[tool.setuptools-git-versioning]
+enabled = true
+dev_template = "{tag}.post{ccount}"
+
+
+[dependency-groups]
+dev = [
+  "ruff~=0.14.11",
+  "prek~=0.2.28",
+]
+test = [
+  "build>=1.1.1",
+  "coverage>=7.2.7",
+  "pytest>=7.4.4",
+  "pytest-rerunfailures>=13.0",
+  "pytest-xdist>=3.5.0",
+  # Some tests need to write TOML, but tomli and tomllib are read-only, and toml package is unmaintained
+  "tomli-w>=1.0.0",
+  "wheel>=0.42.0",
+]
+docs = [
+  "furo~=2025.12.19",
+  "numpydoc~=1.10.0",
+  "sphinx~=8.2.3",
+  "sphinx-argparse~=0.5.2",
+  "sphinx-autodoc-typehints~=3.5.2",
+  "sphinx-copybutton~=0.5.2",
+  "sphinx-last-updated-by-git~=0.3.8",
+  "sphinx-tabs~=3.4.5",
+  "sphinxcontrib-towncrier~=0.5.0a0",
+  "towncrier~=25.8.0",
+  "sphinx-toolbox~=4.1.0",
+]
+
+[tool.uv]
+default-groups = []
+
+[tool.uv.dependency-groups]
+dev = {requires-python = ">=3.12"}
+docs = {requires-python = ">=3.12"}
+
+[tool.ruff]
+target-version = "py37"
+line-length = 120
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = ["ARG", "ANN", "A002", "COM812", "D", "TD", "FIX002", "PLC0415"]
+
+[tool.ruff.lint.per-file-ignores]
+"docs/conf.py" = ["INP001"]
+"tests/*" = [
+    "S",
+    "EM101",
+    "PLR2004",
+    "TRY003",
+    "DTZ005",
+]
+
+[tool.mypy]
+follow_imports = "silent"
+ignore_missing_imports = true
+pretty = true
+show_error_codes = true
+strict_optional = true
+
+[tool.towncrier]
+name = "setuptools-git-versioning"
+package = "setuptools_git_versioning"
+filename = "docs/changelog/NEXT_RELEASE.rst"
+directory = "docs/changelog/next_release/"
+title_format = "{version} ({project_date})"
+issue_format = ":github:pull:`{issue}`"
+
+[[tool.towncrier.type]]
+directory = "breaking"
+name = "Breaking Changes"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "significant"
+name = "Significant Changes"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "feature"
+name = "Features"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "improvement"
+name = "Improvements"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "bugfix"
+name = "Bug Fixes"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "dependency"
+name = "Dependencies"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "doc"
+name = "Doc only Changes"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "misc"
+name = "Misc"
+showcontent = true

setuptools_git_versioning-3.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

setuptools_git_versioning-3.0.0/setuptools_git_versioning/__init__.py

@@ -0,0 +1,41 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+from setuptools_git_versioning.git import (
+    count_since,
+    get_all_tags,
+    get_branch,
+    get_branches,
+    get_latest_file_commit,
+    get_sha,
+    get_tag,
+    get_tags,
+    is_dirty,
+)
+from setuptools_git_versioning.setup import get_version, infer_version
+from setuptools_git_versioning.version import version_from_git
+
+if TYPE_CHECKING:
+    from setuptools.dist import Distribution
+
+
+def parse_config(dist: Distribution, attr: Any, value: Any) -> None:
+    "Dummy function used only to register in distutils"
+    return
+
+
+__all__ = [
+    "count_since",
+    "get_all_tags",
+    "get_branch",
+    "get_branches",
+    "get_latest_file_commit",
+    "get_sha",
+    "get_tag",
+    "get_tags",
+    "get_version",
+    "infer_version",
+    "is_dirty",
+    "version_from_git",
+]

setuptools_git_versioning-3.0.0/setuptools_git_versioning/__main__.py

@@ -0,0 +1,3 @@
+from setuptools_git_versioning.cli import main
+
+main()

setuptools_git_versioning-3.0.0/setuptools_git_versioning/cli.py

@@ -0,0 +1,36 @@
+import argparse
+import logging
+import sys
+
+from setuptools_git_versioning.log import DEBUG, LOG_FORMAT, VERBOSITY_LEVELS
+from setuptools_git_versioning.setup import get_version
+
+
+def get_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        prog="setuptools-git-versioning",
+        description="Get version based on git information and 'setup.py' or 'pyproject.toml' config",
+    )
+    parser.add_argument(
+        "root",
+        type=str,
+        default=None,
+        nargs="?",
+        help="Path to folder containing 'setup.py' or 'pyproject.toml' file. Default: current dir",
+    )
+    parser.add_argument(
+        "--verbose",
+        "-v",
+        action="count",
+        default=0,
+        help="Increase verbosity level. Can be used multiple times: -v for INFO messages, -vv for DEBUG",
+    )
+    return parser
+
+
+def main():
+    parser = get_parser()
+    namespace = parser.parse_args()
+    log_level = VERBOSITY_LEVELS.get(namespace.verbose, DEBUG)
+    logging.basicConfig(level=log_level, format=LOG_FORMAT, stream=sys.stderr)
+    print(str(get_version(root=namespace.root)))  # noqa: T201

setuptools_git_versioning-3.0.0/setuptools_git_versioning/defaults.py

@@ -0,0 +1,26 @@
+from __future__ import annotations
+
+DEFAULT_TEMPLATE = "{tag}"
+DEFAULT_DEV_TEMPLATE = "{tag}.post{ccount}+git.{sha}"
+DEFAULT_DIRTY_TEMPLATE = "{tag}.post{ccount}+git.{sha}.dirty"
+DEFAULT_STARTING_VERSION = "0.0.1"
+DEFAULT_SORT_BY = "creatordate"
+DEFAULT_CONFIG = {
+    "template": DEFAULT_TEMPLATE,
+    "dev_template": DEFAULT_DEV_TEMPLATE,
+    "dirty_template": DEFAULT_DIRTY_TEMPLATE,
+    "starting_version": DEFAULT_STARTING_VERSION,
+    "version_callback": None,
+    "version_file": None,
+    "count_commits_from_version_file": False,
+    "tag_formatter": None,
+    "branch_formatter": None,
+    "tag_filter": None,
+    "sort_by": DEFAULT_SORT_BY,
+}
+
+
+def set_default_options(config: dict):
+    for key, value in DEFAULT_CONFIG.items():
+        config.setdefault(key, value)
+    return config

setuptools_git_versioning-3.0.0/setuptools_git_versioning/factories.py

@@ -0,0 +1,160 @@
+from __future__ import annotations
+
+import importlib
+import inspect
+import logging
+import os
+import re
+import sys
+from typing import Any, Callable
+
+from setuptools_git_versioning.log import DEBUG, INFO
+
+log = logging.getLogger(__name__)
+
+
+def add_to_sys_path(root: str | os.PathLike | None) -> None:
+    project_root = os.fspath(root) if root else os.getcwd()  # noqa: PTH109
+    if project_root not in sys.path:
+        log.log(DEBUG, "Adding '%s' folder to sys.path", project_root)
+        sys.path.insert(0, project_root)
+
+
+def import_reference(
+    ref: str,
+    package_name: str | None = None,
+    root: str | os.PathLike | None = None,
+) -> Any:
+    if ":" not in ref:
+        msg = f"Wrong reference name: {ref}"
+        raise NameError(msg)
+
+    add_to_sys_path(root)
+
+    module_name, attr = ref.split(":")
+    log.log(DEBUG, "Executing 'from %s.%s import %s'", package_name or "", module_name, attr)
+    module = importlib.import_module(module_name, package_name)
+
+    return getattr(module, attr)
+
+
+def load_callable(
+    inp: str,
+    package_name: str | None = None,
+    root: str | os.PathLike | None = None,
+) -> Callable:
+    ref = import_reference(inp, package_name, root=root)
+    if not callable(ref):
+        msg = f"{ref} of type {type(ref)} is not callable"
+        raise TypeError(msg)
+
+    return ref
+
+
+def _callable_factory(
+    callable_name: str,
+    regexp_or_ref: str | Callable,
+    callable_factory: Callable[[str], Callable],
+    package_name: str | None = None,
+    root: str | os.PathLike | None = None,
+) -> Callable:
+    log.log(INFO, "Parsing %s %r of type %r", callable_name, regexp_or_ref, type(regexp_or_ref).__name__)
+
+    if callable(regexp_or_ref):
+        log.log(DEBUG, "Value is callable with signature %s", inspect.Signature.from_callable(regexp_or_ref))
+        return regexp_or_ref
+
+    try:
+        return load_callable(regexp_or_ref, package_name, root=root)
+    except (ImportError, NameError) as 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.exception("%s is not valid regexp neither a valid function reference", callable_name)
+        msg = f"Cannot parse {callable_name}"
+        raise ValueError(msg) from e
+
+
+def branch_formatter_factory(regexp: str) -> Callable[[str], str]:
+    pattern = re.compile(regexp)
+
+    def branch_formatter(branch: str) -> str:
+        match = pattern.match(branch)
+        if match:
+            return match.group("branch")
+
+        msg = f"Branch name {branch} does not match regexp '{regexp}'"
+        raise ValueError(msg)
+
+    return branch_formatter
+
+
+def create_branch_formatter(
+    branch_formatter: Callable[[str], str] | str,
+    package_name: str | None = None,
+    root: str | os.PathLike | None = None,
+):
+    return _callable_factory(
+        callable_name="branch_formatter",
+        regexp_or_ref=branch_formatter,
+        callable_factory=branch_formatter_factory,
+        package_name=package_name,
+        root=root,
+    )
+
+
+def tag_formatter_factory(regexp: str) -> Callable[[str], str]:
+    pattern = re.compile(regexp)
+
+    def tag_formatter(tag: str) -> str:
+        match = pattern.match(tag)
+        if match:
+            return match.group("tag")
+
+        msg = f"Tag name {tag} does not match regexp '{regexp}'"
+        raise ValueError(msg)
+
+    return tag_formatter
+
+
+def create_tag_formatter(
+    tag_formatter: Callable[[str], str] | str,
+    package_name: str | None = None,
+    root: str | os.PathLike | None = None,
+):
+    return _callable_factory(
+        callable_name="tag_formatter",
+        regexp_or_ref=tag_formatter,
+        callable_factory=tag_formatter_factory,
+        package_name=package_name,
+        root=root,
+    )
+
+
+def tag_filter_factory(regexp: str) -> Callable[[str], str | None]:
+    pattern = re.compile(regexp)
+
+    def tag_filter(tag: str) -> str | None:
+        match = pattern.match(tag)
+        if match:
+            log.info("Matched %s", tag)
+            return tag
+        return None
+
+    return tag_filter
+
+
+def create_tag_filter(
+    tag_filter: Callable[[str], str | None] | str,
+    package_name: str | None = None,
+    root: str | os.PathLike | None = None,
+):
+    return _callable_factory(
+        callable_name="tag_filter",
+        regexp_or_ref=tag_filter,
+        callable_factory=tag_filter_factory,
+        package_name=package_name,
+        root=root,
+    )