PyVCC 1.2.1__py3-none-any.whl

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/__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/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/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.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,9 @@
+pyvcc-1.2.1.dist-info/METADATA,sha256=jjA4LTHTyQpS5LkAr2lz7hyj3yCrTNqYymRn5xmCRSU,757
+pyvcc-1.2.1.dist-info/WHEEL,sha256=tSfRZzRHthuv7vxpI4aehrdN9scLjk-dCJkPLzkHxGg,90
+pyvcc-1.2.1.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
+pyvcc-1.2.1.dist-info/licenses/LICENSE,sha256=awOCsWJ58m_2kBQwBUGWejVqZm6wuRtCL2hi9rfa0X4,1211
+pyvcc/__init__.py,sha256=RmBuVRJe0JPS5H6lt3ijpeDPJ8PA7FP757xlIEd5Gy4,156
+pyvcc/__main__.py,sha256=QuN-SbZooLYU_z65E5GlLVRQRcQ6NZosX-FqTpH-vJ0,888
+pyvcc/cli.py,sha256=hvrNbRW2dF1tTuanTw81fCWz_LtZXxn_Jv6y3uokMEY,1567
+pyvcc/semver.py,sha256=4SVd4kcaP9-57f_QrJwLYEZq5mY0HWz0SykghbusHao,4196
+pyvcc-1.2.1.dist-info/RECORD,,

pyvcc-1.2.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: pdm-backend (2.4.4)
+Root-Is-Purelib: true
+Tag: py3-none-any

pyvcc-1.2.1.dist-info/entry_points.txt

@@ -0,0 +1,4 @@
+[console_scripts]
+
+[gui_scripts]
+

pyvcc-1.2.1.dist-info/licenses/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>