PyVCC 1.2.1__tar.gz

pyvcc-1.2.1/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org>

pyvcc-1.2.1/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.1
+Name: PyVCC
+Version: 1.2.1
+Summary: PyVCC python version controller using conventional commits
+Requires-Python: >=3.10
+Requires-Dist: pygit2>=1.18.0
+Requires-Dist: structlog>=25.3.0
+Requires-Dist: typing-extensions>=4.0.0; python_version < "3.11"
+Description-Content-Type: text/markdown
+
+# python-version-controller
+conventional version controller for python
+
+[![codecov](https://codecov.io/gh/lcavalcante/python-version-controller/graph/badge.svg?token=H65NZV7N3Z)](https://codecov.io/gh/lcavalcante/python-version-controller)
+[![tests](https://github.com/lcavalcante/python-version-controller/actions/workflows/code-quality.yml/badge.svg)](https://github.com/lcavalcante/python-version-controller/actions/workflows/code-quality.yml)

pyvcc-1.2.1/README.md

@@ -0,0 +1,5 @@
+# python-version-controller
+conventional version controller for python
+
+[![codecov](https://codecov.io/gh/lcavalcante/python-version-controller/graph/badge.svg?token=H65NZV7N3Z)](https://codecov.io/gh/lcavalcante/python-version-controller)
+[![tests](https://github.com/lcavalcante/python-version-controller/actions/workflows/code-quality.yml/badge.svg)](https://github.com/lcavalcante/python-version-controller/actions/workflows/code-quality.yml)

pyvcc-1.2.1/pyproject.toml

@@ -0,0 +1,101 @@
+[project]
+name = "PyVCC"
+version = "1.2.1"
+description = "PyVCC python version controller using conventional commits"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "pygit2>=1.18.0",
+    "structlog>=25.3.0",
+    "typing-extensions>=4.0.0; python_version < '3.11'",
+]
+
+[dependency-groups]
+dev = [
+    "coverage[toml]>=7.8.0",
+    "pre-commit>=4.2.0",
+    "pytest>=8.3.5",
+    "pytest-cov>=6.1.1",
+    "rich>=14.0.0",
+]
+
+[build-system]
+requires = [
+    "pdm-backend",
+]
+build-backend = "pdm.backend"
+
+[tool.pdm]
+distribution = true
+
+[tool.ruff.lint.isort]
+combine-as-imports = true
+
+[tool.pyright]
+include = [
+    "pyvcc",
+    "tests",
+]
+exclude = [
+    "**/__pycache__",
+    "**/node_modules",
+    "**/.git",
+    ".venv",
+    "venv",
+]
+typeCheckingMode = "standard"
+pythonVersion = "3.13"
+reportMissingImports = true
+reportMissingTypeStubs = false
+
+[tool.coverage.run]
+source = [
+    ".",
+]
+omit = [
+    "*/tests/*",
+    "*/test_*",
+    "*/__pycache__/*",
+    "*/venv/*",
+    ".venv/*",
+    "setup.py",
+    "*/migrations/*",
+    "pyvcc/__main__.py",
+]
+
+[tool.coverage.report]
+precision = 2
+show_missing = true
+skip_covered = false
+fail_under = 80
+exclude_lines = [
+    "pragma: no cover",
+    "def __repr__",
+    "if __name__ == .__main__.:",
+    "raise NotImplementedError",
+    "pass",
+    "except ImportError:",
+]
+
+[tool.coverage.html]
+directory = "coverage_html_report"
+
+[tool.coverage.xml]
+output = "coverage.xml"
+
+[tool.pytest.ini_options]
+addopts = "--cov=. --cov-report=xml --cov-report=html --cov-report=term-missing"
+testpaths = [
+    "tests",
+]
+python_files = [
+    "test_*.py",
+    "*_test.py",
+]
+python_classes = [
+    "Test*",
+    "*Test",
+]
+python_functions = [
+    "test_*",
+]

pyvcc-1.2.1/pyvcc/__init__.py

@@ -0,0 +1,4 @@
+"""PyVCC - Python Version Controller for SemVer manangment with conventional commits"""
+
+from .cli import main as main
+from .semver import SemVer as SemVer

pyvcc-1.2.1/pyvcc/__main__.py

@@ -0,0 +1,27 @@
+"""
+Entry point for running the package as a module.
+"""
+
+import os
+import sys
+import argparse
+import structlog
+from pyvc.cli import main, validate_args
+
+
+log = structlog.get_logger()
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(prog="PyVC", description=__doc__)
+    parser.add_argument("--root", type=str, default=".", required=False)
+    parser.add_argument("--initial-version", type=str, required=False, default="0.1.0")
+    parser.add_argument("--initial-commit", type=str, required=False, default="")
+
+    args = parser.parse_args()
+    root = os.getenv(key="PYVC_REPO_ROOT", default=args.root)
+    version = os.getenv(key="PYVC_INITIAL_VERSION", default=args.initial_version)
+    commit = os.getenv(key="PYVC_INITIAL_COMMIT", default=args.initial_commit)
+    if not validate_args(root=root, version=version):
+        sys.exit(1)
+
+    main(root, version, commit)

pyvcc-1.2.1/pyvcc/cli.py

@@ -0,0 +1,55 @@
+"""
+CLI parsing for pyvc command.
+"""
+
+from pygit2 import Commit
+import structlog
+from pathlib import Path, PurePath
+from pygit2.repository import Repository
+from pygit2.enums import SortMode
+
+from pyvcc.semver import SemVer
+
+
+log = structlog.get_logger()
+
+
+def validate_args(root: str, version: str) -> bool:
+    is_valid = True
+    repo_path = Path(root) / PurePath(".git")
+    if not repo_path.exists():
+        is_valid = False
+        log.error("repo root does not exist", path=repo_path)
+
+    try:
+        SemVer.semver_from_string(version)
+    except Exception as e:
+        log.error("invalid initial version", error=str(e))
+        is_valid = False
+
+    return is_valid
+
+
+def main(root: str, version: str, start_commit_id: str | None = None) -> str:
+    repo_path = Path(root) / PurePath(".git")
+    semver = SemVer.semver_from_string(version)
+
+    repo = Repository(str(repo_path))
+
+    log.debug("starting repo walk", start_commit_id=start_commit_id)
+    commit_walker = repo.walk(repo.head.target, SortMode.TOPOLOGICAL | SortMode.REVERSE)
+
+    # if start_commit is defined for versioning, skip parents on walk
+    if start_commit_id:
+        start_commit = repo[start_commit_id]
+        if isinstance(start_commit, Commit):
+            for parent in start_commit.parent_ids:
+                commit_walker.hide(parent)
+
+    for commit in commit_walker:
+        message = commit.message
+        log.info("commit", id=commit.id, short=commit.short_id)
+        semver.bump_version(message)
+
+    log.info(f"final version {str(semver)}")
+    return str(semver)

pyvcc-1.2.1/pyvcc/semver.py

@@ -0,0 +1,136 @@
+from enum import Enum, auto
+import sys
+import structlog
+
+# Python 3.11+ has Self in typing module
+if sys.version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
+
+
+log = structlog.get_logger()
+
+
+class CommitEnum(Enum):
+    FEAT = auto()
+    FIX = auto()
+    BUILD = auto()
+    CHORE = auto()
+    CI = auto()
+    DOCS = auto()
+    STYLE = auto()
+    REFACTOR = auto()
+    PERF = auto()
+    TEST = auto()
+
+
+class BumpEnum(Enum):
+    MAJOR = auto()
+    MINOR = auto()
+    PATCH = auto()
+    NO_BUMP = auto()
+
+
+class SemVer:
+    def __init__(self, major: int, minor: int, patch: int):
+        self.major = major
+        self.minor = minor
+        self.patch = patch
+
+        self.log = log
+
+    def __repr__(self):
+        return f"{self.major}.{self.minor}.{self.patch}"
+
+    @staticmethod
+    def is_breaking_change(type: str, message: str) -> bool:
+        """
+        SemVer defines that a breaking change is a commit with a type ending in '!'
+        OR that contains 'BREAKING CHANGE:' in the messsage body
+
+        # Parameters:
+        type (str): Commit message type (feat, fix, chore, etc)
+        message (str): commit message content
+        """
+        return type[-1] == "!" or "BREAKING CHANGE:" in message
+
+    @classmethod
+    def semver_from_string(cls, str_version: str) -> Self:
+        # TODO: regex?
+        list_version = str_version.split(".")
+        if len(list_version) != 3:
+            # TODO: custom exception
+            raise Exception("invalid string formating for semantic versioning")
+
+        major = int(list_version[0])
+        minor = int(list_version[1])
+        patch = int(list_version[2])
+        return cls(major, minor, patch)
+
+    @classmethod
+    def bump_type(cls, message: str) -> BumpEnum:
+        """
+        Given a version number MAJOR.MINOR.PATCH, increment the:
+
+        - MAJOR: version when you make incompatible API changes
+        - MINOR: version when you add functionality in a backward compatible manner
+        - PATCH: version when you make backward compatible bug fixes
+        Additional labels for pre-release and build metadata are available as
+        extensions to the MAJOR.MINOR.PATCH format.
+
+        fix: a commit of the type fix patches a bug in your codebase
+             (this correlates with PATCH in Semantic Versioning).
+
+        feat: a commit of the type feat introduces a new feature to the codebase
+            (this correlates with MINOR in Semantic Versioning).
+
+        BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a !
+                         after the type/scope, introduces a breaking API change
+                         (correlating with MAJOR in Semantic Versioning).
+                         A BREAKING CHANGE can be part of commits of any type.
+
+        # Parameters:
+        message (str): commit message content
+        """
+
+        bump = BumpEnum.NO_BUMP
+        head = message.split("\n")[0]
+
+        # TODO: regex?
+        parsed_head = head.split(":")
+
+        if len(parsed_head) > 1:
+            commit_type = parsed_head[0].strip().upper()
+
+            if cls.is_breaking_change(commit_type, message):
+                bump = BumpEnum.MAJOR
+            elif commit_type == CommitEnum.FEAT.name:
+                bump = BumpEnum.MINOR
+            elif commit_type == CommitEnum.FIX.name:
+                bump = BumpEnum.PATCH
+            else:
+                bump = BumpEnum.NO_BUMP
+        else:
+            log.info("not in conventional commit spec", message=head)
+
+        return bump
+
+    def bump_version(self, message: str) -> None:
+        self.log = self.log.bind(message=message)
+
+        match self.bump_type(message):
+            case BumpEnum.MAJOR:
+                self.major += 1
+                self.minor = 0
+                self.patch = 0
+                self.log.debug("bump Major")
+            case BumpEnum.MINOR:
+                self.minor += 1
+                self.patch = 0
+                self.log.debug("bump Minor")
+            case BumpEnum.PATCH:
+                self.patch += 1
+                self.log.debug("bump Patch")
+            case BumpEnum.NO_BUMP:
+                self.log.debug("no bump")

pyvcc-1.2.1/tests/cli/test_cli.py

@@ -0,0 +1,73 @@
+from pygit2 import Commit
+import pytest
+from pygit2.repository import Repository
+
+from pyvcc.cli import main, validate_args
+from pyvcc.semver import BumpEnum, SemVer
+
+
+class MockCommit:
+    def __init__(self, message, id, short_id):
+        self.message = message
+        self.id = id
+        self.short_id = short_id
+
+
+def test_main_invalid_path():
+    with pytest.raises(Exception):
+        main("/(7", "1.0.0")
+
+
+def test_main_invalid_semver():
+    with pytest.raises(Exception):
+        main(".", "1.0.0.2")
+
+
+def test_validate_version():
+    assert validate_args(".", "1.0.a") is False
+
+
+def test_validate_path():
+    assert validate_args("/(??", "1.1.1") is False
+
+
+def test_validate_true():
+    assert validate_args(".", "1.2.3") is True
+
+
+def test_single_commit(monkeypatch):
+    def mock_walk(*args, **kwargs):  # noqa
+        return [MockCommit(message="feat: x", id="123456789", short_id="1234567")]
+
+    monkeypatch.setattr(Repository, "walk", mock_walk)
+
+    assert main(".", "1.0.0") == "1.1.0"
+
+
+def test_two_commits(monkeypatch):
+    def mock_walk(*args, **kwargs):  # noqa
+        return [
+            MockCommit(message="feat: x", id="123456789", short_id="1234567"),
+            MockCommit(message="feat: y", id="234456789", short_id="2344567"),
+        ]
+
+    monkeypatch.setattr(Repository, "walk", mock_walk)
+
+    assert main(".", "1.0.0") == "1.2.0"
+
+
+def test_head_bump_commit():
+    repo = Repository(".git")
+    commit = repo[repo.head.target]
+
+    if isinstance(commit, Commit):
+        message = commit.message
+        match SemVer.bump_type(message):
+            case BumpEnum.MAJOR:
+                assert main(".", "1.0.0", str(repo.head.target)) == "2.0.0"
+            case BumpEnum.MINOR:
+                assert main(".", "1.0.0", str(repo.head.target)) == "1.1.0"
+            case BumpEnum.PATCH:
+                assert main(".", "1.0.0", str(repo.head.target)) == "1.0.1"
+            case BumpEnum.NO_BUMP:
+                assert main(".", "1.0.0", str(repo.head.target)) == "1.0.0"

pyvcc-1.2.1/tests/semver/conftest.py

@@ -0,0 +1,117 @@
+import pytest
+from pyvcc import SemVer
+
+
+@pytest.fixture
+def initial_version() -> SemVer:
+    return SemVer(0, 1, 0)
+
+
+# Conventional feature commits
+@pytest.fixture
+def feat_commit():
+    return ("feat", "feat: Add new user authentication API")
+
+
+@pytest.fixture
+def feat_breaking_with_exclamation():
+    return ("feat!", "feat!: Redesign API endpoint structure")
+
+
+@pytest.fixture
+def feat_breaking_with_text():
+    return (
+        "feat",
+        """feat: Migrate to new database schema
+
+BREAKING CHANGE: Database schema has changed and requires migration""",
+    )
+
+
+# Conventional fix commits
+@pytest.fixture
+def fix_commit():
+    return ("fix", "fix: Resolve login error on Safari")
+
+
+@pytest.fixture
+def fix_commit_with_body():
+    return (
+        "fix",
+        """fix: Fix memory leak in background process
+
+The background process was not properly releasing resources
+when tasks completed.""",
+    )
+
+
+@pytest.fixture
+def fix_breaking_with_exclamation():
+    return ("fix!", "fix!: Change authentication flow completely")
+
+
+# Other conventional commits
+@pytest.fixture
+def chore_commit():
+    return ("chore", "chore: Update dependencies")
+
+
+@pytest.fixture
+def docs_commit():
+    return ("docs", "docs: Update README installation instructions")
+
+
+@pytest.fixture
+def style_commit():
+    return ("style", "style: Format code according to new style guide")
+
+
+@pytest.fixture
+def refactor_commit():
+    return ("refactor", "refactor: Simplify user management functions")
+
+
+@pytest.fixture
+def test_commit():
+    return ("test", "test: Add new test cases for payment processing")
+
+
+@pytest.fixture
+def ci_commit():
+    return ("ci", "ci: Update GitHub Actions workflow")
+
+
+@pytest.fixture
+def build_commit():
+    return ("build", "build: Migrate to Webpack 5")
+
+
+@pytest.fixture
+def perf_commit():
+    return ("perf", "perf: Optimize image loading process")
+
+
+@pytest.fixture
+def chore_breaking_commit():
+    return (
+        "chore!",
+        """chore!: Drop support for legacy browsers
+
+This removes polyfills and workarounds for older browsers.""",
+    )
+
+
+# Non-conventional commits
+@pytest.fixture
+def no_cc_simple_commit():
+    return (None, "Added new feature")
+
+
+@pytest.fixture
+def no_cc_bug_number_commit():
+    return ("Fixed bug", "Fixed bug: #123")
+
+
+@pytest.fixture
+def no_cc_doc_commit_non_conventional():
+    return (None, "Updated documentation")

pyvcc-1.2.1/tests/semver/test_breaking_change.py

@@ -0,0 +1,41 @@
+from pyvcc.semver import SemVer
+
+
+def test_feat_normal(feat_commit):
+    commit_type, message = feat_commit
+    assert SemVer.is_breaking_change(commit_type, message) is False
+
+
+def test_fix_normal(fix_commit):
+    commit_type, message = fix_commit
+    assert SemVer.is_breaking_change(commit_type, message) is False
+
+
+def test_feat_with_exclamation(feat_breaking_with_exclamation):
+    commit_type, message = feat_breaking_with_exclamation
+    assert SemVer.is_breaking_change(commit_type, message) is True
+
+
+def test_fix_with_exclamation(fix_breaking_with_exclamation):
+    commit_type, message = fix_breaking_with_exclamation
+    assert SemVer.is_breaking_change(commit_type, message) is True
+
+
+def test_with_breaking_change_text(feat_breaking_with_text):
+    commit_type, message = feat_breaking_with_text
+    assert SemVer.is_breaking_change(commit_type, message) is True
+
+
+def test_chore_normal(chore_commit):
+    commit_type, message = chore_commit
+    assert SemVer.is_breaking_change(commit_type, message) is False
+
+
+def test_docs_normal(docs_commit):
+    commit_type, message = docs_commit
+    assert SemVer.is_breaking_change(commit_type, message) is False
+
+
+def test_chore_with_exclamation():
+    commit_type, message = ("chore!", "Major dependency update")
+    assert SemVer.is_breaking_change(commit_type, message) is True

pyvcc-1.2.1/tests/semver/test_bump_version.py

@@ -0,0 +1,118 @@
+import pytest
+from pyvcc.semver import SemVer
+
+
+def test_bump_major(feat_breaking_with_text: tuple[str, str]):
+    version = SemVer(0, 1, 0)
+    message = feat_breaking_with_text[1]
+    version.bump_version(message)
+    assert str(version) == "1.0.0"
+
+
+def test_bump_major_2(feat_breaking_with_exclamation: tuple[str, str]):
+    version = SemVer(0, 1, 0)
+    message = feat_breaking_with_exclamation[1]
+    version.bump_version(message)
+    assert str(version) == "1.0.0"
+
+
+def test_bump_minor(feat_commit: tuple[str, str]):
+    version = SemVer(0, 1, 0)
+    message = feat_commit[1]
+    version.bump_version(message)
+    assert str(version) == "0.2.0"
+
+
+def test_bump_patch(fix_commit: tuple[str, str]):
+    version = SemVer(0, 1, 0)
+    message = fix_commit[1]
+    version.bump_version(message)
+    assert str(version) == "0.1.1"
+
+
+def test_no_bump(docs_commit: tuple[str, str]):
+    version = SemVer(0, 1, 0)
+    message = docs_commit[1]
+    version.bump_version(message)
+    assert str(version) == "0.1.0"
+
+
+def test_no_bump_not_conventional(no_cc_bug_number_commit: tuple[str, str]):
+    version = SemVer(1, 0, 0)
+    message = no_cc_bug_number_commit[1]
+    version.bump_version(message)
+    assert str(version) == "1.0.0"
+
+
+def test_no_bump_no_type(no_cc_simple_commit: tuple[str, str]):
+    version = SemVer(1, 0, 0)
+    message = no_cc_simple_commit[1]
+    version.bump_version(message)
+    assert str(version) == "1.0.0"
+
+
+def test_bump_multiple():
+    """patch -> minor -> major"""
+    version = SemVer(0, 1, 0)
+
+    version.bump_version("fix: Fix login bug")
+    assert str(version) == "0.1.1"
+
+    version.bump_version("feat: Add new feature")
+    assert str(version) == "0.2.0"
+
+    version.bump_version("feat!: Complete API redesign")
+    assert str(version) == "1.0.0"
+
+
+def test_bump_multiple2():
+    """patch -> patch -> major"""
+    version = SemVer(0, 1, 0)
+
+    version.bump_version("fix: Fix login bug")
+    assert str(version) == "0.1.1"
+
+    version.bump_version("fix: Fix logout bug")
+    assert str(version) == "0.1.2"
+
+    version.bump_version("feat: New API\n\nBREAKING CHANGE: Complete API redesign")
+    assert str(version) == "1.0.0"
+
+
+def test_bump_multiple3():
+    """patch -> major -> minor"""
+    version = SemVer(0, 1, 0)
+
+    version.bump_version("fix: Fix login bug")
+    assert str(version) == "0.1.1"
+
+    version.bump_version("feat!: Complete API redesign")
+    assert str(version) == "1.0.0"
+
+    version.bump_version("feat: Add new feature")
+    assert str(version) == "1.1.0"
+
+
+def test_bump_multiple4():
+    """patch -> patch -> minor"""
+    version = SemVer(0, 1, 0)
+
+    version.bump_version("fix: Fix login bug")
+    assert str(version) == "0.1.1"
+
+    version.bump_version("fix: Fix logout bug")
+    assert str(version) == "0.1.2"
+
+    version.bump_version("feat: Add new feature")
+    assert str(version) == "0.2.0"
+
+
+def test_parse_semver_str():
+    version = SemVer.semver_from_string("1.1.0")
+    assert str(version) == "1.1.0"
+
+
+def test_parse_semver_invalid_str():
+    with pytest.raises(Exception) as excinfo:
+        SemVer.semver_from_string("1.1.0.2")
+    assert "invalid string" in str(excinfo)