tinysemver 2.0.7__tar.gz → 2.1.0__tar.gz

{tinysemver-2.0.7/tinysemver.egg-info → tinysemver-2.1.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: tinysemver
-Version: 2.0.7
-Summary: Tiny Semantic Versioning (SemVer) library, that doesn't depend on 300K lines of JavaScript
+Version: 2.1.0
+Summary: Semantic-Versioning with LLMs and without 300,000 lines of JS
 Author-email: Ash Vardanian <1983160+ashvardanian@users.noreply.github.com>, Guillaume de Rouville <31691250+grouville@users.noreply.github.com>
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -210,7 +210,7 @@ Project-URL: Documentation, https://github.com/ashvardanian/tinysemver/blob/main
 Project-URL: Repository, https://github.com/ashvardanian/tinysemver.git
 Project-URL: Issues, https://github.com/ashvardanian/tinysemver/issues
 Project-URL: Changelog, https://github.com/ashvardanian/tinysemver/blob/main/CHANGELOG.md
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Build Tools
 Classifier: License :: OSI Approved :: Apache Software License
@@ -223,10 +223,12 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: openai>=1.54.4
+Requires-Dist: rich>=13.8.0
 
-![](https://github.com/ashvardanian/ashvardanian/blob/master/repositories/TinySemVer.jpg)
+![TinySemVer Banner](https://github.com/ashvardanian/ashvardanian/blob/master/repositories/TinySemVer.jpg)
 
-__TinySemVer__ is a minimalistic [Semantic Versioning](https://semver.org/) package for projects following [Conventional Commits](https://www.conventionalcommits.org/) in a single short Python file.
+__TinySemVer__ is a minimalistic [Semantic Versioning](https://semver.org/) package for projects following [Conventional Commits](https://www.conventionalcommits.org/) in a single short Python file, capable of generating changelogs and release notes with the use of OpenAI-compatible LLM APIs, or without them.
 In plain English, if your commit messages look like `feat: add new feature` or `fix: bugfix`, this package will automate releasing new "GIT tags" based on the commit messages.
 Here is how to integrate it into your project CI:
 
@@ -304,6 +306,19 @@ Alternatively, you can just ask for `--help`:
 $ tinysemver --help
 ```
 
+## AI and Rock-n-Roll
+
+TinySemVer can leverage a language model to validate the commits and generate clean and infromative release notes.
+
+```sh
+$ tinysemver --verbose \
+    --github-repository 'ashvardanian/tinysemver' \
+    --openai-base-url 'https://api.groq.com/openai/v1' \
+    --openai-api-key 'GET_YOURSELF_A_KEY' \
+    --openai-model 'llama-3.2-11b-text-preview' \
+    --dry-run
+```
+
 ## Usage Details for the GitHub CI Action
 
 TinySemVer can be easily integrated into your GitHub Actions CI pipeline.

{tinysemver-2.0.7 → tinysemver-2.1.0}/README.md

@@ -1,6 +1,6 @@
-![](https://github.com/ashvardanian/ashvardanian/blob/master/repositories/TinySemVer.jpg)
+![TinySemVer Banner](https://github.com/ashvardanian/ashvardanian/blob/master/repositories/TinySemVer.jpg)
 
-__TinySemVer__ is a minimalistic [Semantic Versioning](https://semver.org/) package for projects following [Conventional Commits](https://www.conventionalcommits.org/) in a single short Python file.
+__TinySemVer__ is a minimalistic [Semantic Versioning](https://semver.org/) package for projects following [Conventional Commits](https://www.conventionalcommits.org/) in a single short Python file, capable of generating changelogs and release notes with the use of OpenAI-compatible LLM APIs, or without them.
 In plain English, if your commit messages look like `feat: add new feature` or `fix: bugfix`, this package will automate releasing new "GIT tags" based on the commit messages.
 Here is how to integrate it into your project CI:
 
@@ -78,6 +78,19 @@ Alternatively, you can just ask for `--help`:
 $ tinysemver --help
 ```
 
+## AI and Rock-n-Roll
+
+TinySemVer can leverage a language model to validate the commits and generate clean and infromative release notes.
+
+```sh
+$ tinysemver --verbose \
+    --github-repository 'ashvardanian/tinysemver' \
+    --openai-base-url 'https://api.groq.com/openai/v1' \
+    --openai-api-key 'GET_YOURSELF_A_KEY' \
+    --openai-model 'llama-3.2-11b-text-preview' \
+    --dry-run
+```
+
 ## Usage Details for the GitHub CI Action
 
 TinySemVer can be easily integrated into your GitHub Actions CI pipeline.

{tinysemver-2.0.7 → tinysemver-2.1.0}/pyproject.toml

@@ -4,8 +4,8 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "tinysemver"
-version = "2.0.7"
-description = "Tiny Semantic Versioning (SemVer) library, that doesn't depend on 300K lines of JavaScript"
+version = "2.1.0"
+description = "Semantic-Versioning with LLMs and without 300,000 lines of JS"
 readme = "README.md"
 license = { file = "LICENSE" }
 authors = [
@@ -13,7 +13,7 @@ authors = [
     { name = "Guillaume de Rouville", email = "31691250+grouville@users.noreply.github.com" },
 ]
 classifiers = [
-    "Development Status :: 4 - Beta",
+    "Development Status :: 5 - Production/Stable",
     "Intended Audience :: Developers",
     "Topic :: Software Development :: Build Tools",
     "License :: OSI Approved :: Apache Software License",
@@ -25,6 +25,7 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
 ]
+dependencies = ["openai >= 1.54.4", "rich >= 13.8.0"]
 
 [project.scripts]
 tinysemver = "tinysemver.tinysemver:main"

{tinysemver-2.0.7 → tinysemver-2.1.0}/tinysemver/tinysemver.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 # -*- coding: utf-8 -*-
-"""TinySemVer is a tiny Python script that helps you manage your project's versioning.
+"""TinySemVer is a tiny but mighty Semantic Versioning tool with AI, Drugs, and Rock-n-Roll.
 
 This module traces the commit history of a Git repository after the last tag, and based 
 on the commit messages, it determines the type of version bump (major, minor, or patch).
@@ -15,6 +15,7 @@ Example:
         --minor-verbs 'feature,minor,add,new' \
         --patch-verbs 'fix,patch,bug,improve,docs,make' \
         --changelog-file 'CHANGELOG.md' \
+        --guide-file 'CONTIBUTING.md' \
         --version-file 'VERSION' \
         --update-version-in 'package.json' '"version": "(.*)"' \
         --update-version-in 'CITATION.cff' '^version: (.*)' \
@@ -32,6 +33,7 @@ By default, the following conventions are used:
     - The repository must be a Git repository.
     - It must contain a "VERSION" and "CHANGELOG.md" files in the root directory.
     - The changelog is append-only - sorted in chronological order.
+    - The contibution guide is in the "CONTRIBUTING.md" file.
 
 Setting up a new project:
 
@@ -47,13 +49,16 @@ import argparse
 import subprocess
 import re
 import os
-from typing import List, Tuple, Literal, Union, Optional
+from typing import List, Tuple, Literal, Union, Optional, NamedTuple
 from datetime import datetime
 import traceback
 
+
 SemVer = Tuple[int, int, int]
 BumpType = Literal["major", "minor", "patch"]
 PathLike = Union[str, os.PathLike]
+Commit = NamedTuple("Commit", [("hash", str), ("message", str)])
+ChangeDiff = str
 
 
 class NoNewCommitsError(Exception):
@@ -62,6 +67,69 @@ class NoNewCommitsError(Exception):
     pass
 
 
+class MayContainVulnerability(Warning):
+    """Raised when the commit may contain a vulnerability."""
+
+    pass
+
+
+class MayContainLogicalBugs(Warning):
+    """Raised when the commit may contain logical bugs."""
+
+    pass
+
+
+class MayContainBreakingChange(Warning):
+    """Raised when the commit may contain a breaking change."""
+
+    pass
+
+
+class MayLackDocumentation(Warning):
+    """Raised when the commit may lack documentation updates."""
+
+    pass
+
+
+class UnknownCommitWarning(Warning):
+    """Something in the commit doesn't add up."""
+
+    pass
+
+
+_console = None  # Initialize global console variable
+_console_is_rich = True  # Initialize global console type variable
+_openai_client = None  # Initialize global OpenAI client variable
+
+
+def print_to_console(message: str) -> None:
+    """Print a message to the console."""
+    global _console, _console_is_rich
+    if _console == None and _console_is_rich:
+        try:
+            from rich import Console
+
+            _console = Console()
+        except ImportError:
+            _console = None
+            _console_is_rich = False
+
+    if _console_is_rich:
+        _console.print(message)
+    else:
+        print(message)
+
+
+def get_open_ai_client(base_url: str, api_key: str):
+    # Create a global variable for the client
+    global _openai_client
+    if not _openai_client:
+        from openai import OpenAI
+
+        _openai_client = OpenAI(base_url=base_url, api_key=api_key)
+    return _openai_client
+
+
 def get_last_tag(repository_path: PathLike) -> str:
     """Retrieve the last Git tag name from the repository."""
     result = subprocess.run(
@@ -75,7 +143,7 @@ def get_last_tag(repository_path: PathLike) -> str:
     return result.stdout.strip().decode("utf-8")
 
 
-def get_commits_since_tag(repository_path: PathLike, tag: str) -> Tuple[List[str], List[str]]:
+def get_commits_since_tag(repository_path: PathLike, tag: str) -> List[Commit]:
     """Get commit hashes and messages since the specified Git tag."""
     result = subprocess.run(
         ["git", "log", f"{tag}..HEAD", "--no-merges", "--pretty=format:%h:%s"],
@@ -88,8 +156,22 @@ def get_commits_since_tag(repository_path: PathLike, tag: str) -> Tuple[List[str
 
     lines = result.stdout.strip().decode("utf-8").split("\n")
     hashes = [line.partition(":")[0] for line in lines if line.strip()]
-    commits = [line.partition(":")[2] for line in lines if line.strip()]
-    return hashes, commits
+    messages = [line.partition(":")[2] for line in lines if line.strip()]
+    return [Commit(h, m) for h, m in zip(hashes, messages)]
+
+
+def get_diff_for_commit(repository_path: PathLike, commit_hash: str) -> ChangeDiff:
+    """Retrieve the diff for a specific commit and parse into Change named tuples."""
+    result = subprocess.run(
+        ["git", "diff", f"{commit_hash}^", commit_hash, "--unified=3"],
+        stdout=subprocess.PIPE,
+        stderr=subprocess.PIPE,
+        cwd=repository_path,
+    )
+    if result.returncode != 0:
+        raise RuntimeError(f"Failed to retrieve diff for commit: {commit_hash}")
+
+    return result.stdout.decode("utf-8")
 
 
 def parse_version(tag: str) -> SemVer:
@@ -119,27 +201,45 @@ def normalize_verbs(verbs: Union[str, List[str]], defaults: List[str]) -> List[s
 
 
 def group_commits(
-    commits: List[str],
+    commits: List[Commit],
     major_verbs: List[str],
     minor_verbs: List[str],
     patch_verbs: List[str],
-) -> Tuple[List[str], List[str], List[str]]:
+) -> Tuple[List[Commit], List[Commit], List[Commit]]:
     """Group commits into major, minor, and patch categories based on keywords to simplify future `BumpType` resolution."""
     major_commits = []
     minor_commits = []
     patch_commits = []
 
     for commit in commits:
-        if any(commit_starts_with_verb(commit, verb) for verb in major_verbs):
+        if any(commit_starts_with_verb(commit.message, verb) for verb in major_verbs):
             major_commits.append(commit)
-        if any(commit_starts_with_verb(commit, verb) for verb in minor_verbs):
+        if any(commit_starts_with_verb(commit.message, verb) for verb in minor_verbs):
             minor_commits.append(commit)
-        if any(commit_starts_with_verb(commit, verb) for verb in patch_verbs):
+        if any(commit_starts_with_verb(commit.message, verb) for verb in patch_verbs):
             patch_commits.append(commit)
 
     return major_commits, minor_commits, patch_commits
 
 
+def convert_commits_to_message(
+    major_commits: List[Commit],
+    minor_commits: List[Commit],
+    patch_commits: List[Commit],
+) -> str:
+    """Turns the different commits (major, minor, patch) into a single message."""
+    message = ""
+
+    if len(major_commits):
+        message += f"\n### Major\n\n" + "\n".join(f"- {c.message} ({c.hash})" for c in major_commits) + "\n"
+    if len(minor_commits):
+        message += f"\n### Minor\n\n" + "\n".join(f"- {c.message} ({c.hash})" for c in minor_commits) + "\n"
+    if len(patch_commits):
+        message += f"\n### Patch\n\n" + "\n".join(f"- {c.message} ({c.hash})" for c in patch_commits) + "\n"
+
+    return message
+
+
 def bump_version(version: SemVer, bump_type: BumpType) -> SemVer:
     """Bump the version based on the specified bump type (major, minor, patch)."""
     major, minor, patch = version
@@ -162,6 +262,9 @@ def create_tag(
     github_repository: Optional[str] = None,
     push: bool = False,
     create_release: bool = False,
+    major_commits: List[Commit] = None,
+    minor_commits: List[Commit] = None,
+    patch_commits: List[Commit] = None,
 ) -> None:
     """Create a new Git tag and optionally push it to a remote GitHub repository."""
 
@@ -172,7 +275,10 @@ def create_tag(
     env["GIT_AUTHOR_NAME"] = user_name
     env["GIT_AUTHOR_EMAIL"] = user_email
     env["GITHUB_TOKEN"] = github_token
+
     message = f"Release: {tag} [skip ci]"
+    message += convert_commits_to_message(major_commits or [], minor_commits or [], patch_commits or [])
+
     subprocess.run(["git", "add", "-A"], cwd=repository_path)
     subprocess.run(["git", "commit", "-m", message], cwd=repository_path, env=env)
 
@@ -186,7 +292,7 @@ def create_tag(
     ).stdout.strip()
 
     subprocess.run(["git", "tag", "-a", tag, "-m", message, new_commit_sha], cwd=repository_path, env=env)
-    print(f"Created new tag: {tag}")
+    print_to_console(f"[bold green]Created new tag:[/bold green] {tag}")
     if push:
         url = None
         if github_token and github_repository:
@@ -197,11 +303,6 @@ def create_tag(
             assert github_repository and not github_token, "You can't provide the GitHub token without the repository"
             url = f"https://github.com/{github_repository}"
 
-        # Pull the latest changes from the remote repository
-        # pull_result = subprocess.run(["git", "pull", "--merge", url], cwd=repository_path, env=env)
-        # if pull_result.returncode != 0:
-        #     raise RuntimeError("Failed to pull the latest changes from the remote repository")
-
         # Push both commits and the tag
         push_result = subprocess.run(
             ["git", "push", url, f"{new_commit_sha}:{default_branch}"],
@@ -211,15 +312,15 @@ def create_tag(
         )
         if push_result.returncode != 0:
             raise RuntimeError(
-                f"Failed to push the new commits to the remote repository: '{url}' with error: {push_result.stderr}"
+                f"Failed to push the new commits to the remote repository: '{url}' with error: {push_result.stderr.decode('utf-8')}"
             )
 
         push_result = subprocess.run(["git", "push", url, "--tag"], cwd=repository_path, capture_output=True, env=env)
         if push_result.returncode != 0:
             raise RuntimeError(
-                f"Failed to push the new tag to the remote repository: '{url}' with error: {push_result.stderr}"
+                f"Failed to push the new tag to the remote repository: '{url}' with error: {push_result.stderr.decode('utf-8')}"
             )
-        print(f"Pushed to: {url}")
+        print_to_console(f"[bold green]Pushed to:[/bold green] {url}")
 
         # Create a release using GitHub CLI if available
         if create_release and github_repository:
@@ -249,13 +350,15 @@ def create_tag(
                 )
 
                 if release_result.returncode == 0:
-                    print(f"Created GitHub release for tag: {tag}")
+                    print_to_console(f"[bold green]Created GitHub release for tag:[/bold green] {tag}")
                 else:
-                    print(f"Failed to create GitHub release: {release_result.stderr}")
+                    print_to_console(
+                        f"[bold red]Failed to create GitHub release:[/bold red] {release_result.stderr.strip()}"
+                    )
             except subprocess.CalledProcessError:
-                print("GitHub CLI not available. Skipping release creation.")
+                print_to_console("[bold yellow]GitHub CLI not available. Skipping release creation.[/bold yellow]")
             except Exception as e:
-                print(f"An error occurred while creating the release: {str(e)}")
+                print_to_console(f"[bold red]An error occurred while creating the release:[/bold red] {str(e)}")
 
 
 def patch_with_regex(
@@ -282,8 +385,7 @@ def patch_with_regex(
         )
         return updated
 
-    # Without using the re.MULTILINE flag,
-    # the ^ and $ anchors match the start and end of the whole string.
+    # Compile the regex pattern with multiline support
     regex_pattern = re.compile(regex_pattern, re.MULTILINE)
     matches = list(re.finditer(regex_pattern, old_content))
     new_content = re.sub(regex_pattern, replace_first_group, old_content, 1)
@@ -297,13 +399,120 @@ def patch_with_regex(
         new_slice = re.sub(regex_pattern, replace_first_group, old_slice, 1)
 
         if verbose:
-            print(f"Will update file: {file_path}:{match_line}")
-            print(f"- {old_slice}")
-            print(f"+ {new_slice}")
+            print_to_console(f"[bold cyan]Will update file:[/bold cyan] {file_path}:{match_line}")
+            print_to_console(f"[red]- {old_slice}[/red]")
+            print_to_console(f"[green]+ {new_slice}[/green]")
 
     if not dry_run:
         with open(file_path, "w") as file:
             file.write(new_content)
+        if verbose:
+            print_to_console(f"[bold green]File updated successfully:[/bold green] {file_path}")
+
+
+def validate_commit_with_llms(
+    base_url: str,
+    api_key: str,
+    model: Optional[str],
+    commit: Commit,
+    change: ChangeDiff,
+) -> Optional[Warning]:
+    prompt = f"""
+        You are a professional coding assistant helping me to validate a commit message and its changes.
+        
+        1. Check if the changed code is likely to introduce logical bugs.
+        2. Check if the commit message is likely to contain a vulnerability.
+        3. Check if it contains a breaking change that is likely to affect users.
+        4. Check if the documentation wasn't updated for the changes made.
+
+        Don't let the commit message fool you, just look at the changes made in the code.
+        Reply by choosing any number from 0 to 4 and describe the issue, if anything is found.
+
+        0. No issues found.
+        1. The commit may introduce logical bugs, such as the overflow in ...
+        2. The commit may contain a vulnerability, such as the SQL injection in ...
+        3. The commit may contain a breaking change, such as the removal of ...
+        4. The commit may lack documentation updates for the changes made in function ...
+        """
+    message = f"""
+        #{commit.hash}: {commit.message}
+
+        Changes:
+
+        {change}
+        """
+    client = get_open_ai_client(base_url=base_url, api_key=api_key)
+    response = client.chat.completions.create(
+        messages=[
+            {"role": "system", "content": prompt},
+            {"role": "user", "content": message},
+        ],
+        max_tokens=256,
+        model=model,
+        stream=False,
+    )
+    response_text = response.choices[0].message.content
+    if response_text.startswith("0."):
+        return None
+    if response_text.startswith("1."):
+        return MayContainLogicalBugs(response_text)
+    if response_text.startswith("2."):
+        return MayContainVulnerability(response_text)
+    if response_text.startswith("3."):
+        return MayContainBreakingChange(response_text)
+    if response_text.startswith("4."):
+        return MayLackDocumentation(response_text)
+    return UnknownCommitWarning(response_text)
+
+
+def aggregate_release_notes_with_llms(
+    base_url: str,
+    api_key: str,
+    model: Optional[str],
+    github_repository: str,
+    commits: List[Commit],
+    changes: List[ChangeDiff],
+) -> str:
+
+    commits_with_hashes = "\n".join(f"- {commit.hash}: {commit.message}" for commit in commits)
+    prompt = f"""
+        You are a release notes generator for an advanced software project.
+
+        Aggregate the release notes for the upcoming version based on the commits and their 
+        changes replying in a Github-flavored Markdown format.
+
+        - Mention the new features, improvements, and bug fixes.
+        - Warn about potential breaking changes and vulnerabilities.
+        - Tag people and teams responsible for the changes.
+        - For the most important commits provide a link to the issue or pull request and 
+          a URL to that commit, like [commit](https://github.com/{github_repository}/commit/...).
+        - Don't guess anything, only use the information from the commits and their changes.
+        - Use inline math notation, like $\\beta=1$ or math blocks like the following, when needed:
+
+          ```math
+          \\S_i(A, B, \\alpha, \\beta) = \\alpha \\cdot A_i + \\beta \\cdot B_i
+          ```
+
+        - Use alerting quotes, like: [!CAUTION] or [!TIP], when needed.
+    """
+    header_message = f"""Commits:
+
+    {commits_with_hashes}
+    """
+    changes_messages = [f"#{commit.hash}: {commit.message}\n{change}" for commit, change in zip(commits, changes)]
+
+    client = OpenAI(base_url=base_url, api_key=api_key)
+    response = client.chat.completions.create(
+        messages=[
+            {"role": "system", "content": prompt},
+            {"role": "user", "content": header_message},
+            *[{"role": "user", "content": message} for message in changes_messages],
+        ],
+        max_tokens=2048,
+        model=model,
+        stream=False,
+    )
+    return response.choices[0].message.content
 
 
 def bump(
@@ -325,6 +534,9 @@ def bump(
     push: bool = True,
     github_token: Optional[str] = None,
     github_repository: Optional[str] = None,
+    openai_base_url: str = "https://api.openai.com",
+    openai_api_key: Optional[str] = None,
+    openai_model: Optional[str] = None,
     default_branch: str = "main",
     create_release: bool = False,
 ) -> SemVer:
@@ -350,6 +562,9 @@ def bump(
         push (bool): If True, pushes the changes to the remote GitHub repository. Defaults to True.
         github_token (Optional[str]): The GitHub token for authentication. If None, it attempts to use the GH_TOKEN environment variable. Defaults to None.
         github_repository (Optional[str]): The GitHub repository in 'owner/repo' format. If None, it attempts to use the GH_REPOSITORY environment variable. Defaults to None.
+        openai_base_url (str): The OpenAI API base URL. Defaults to "https://api.openai.com".
+        openai_api_key (Optional[str]): The OpenAI API key. Defaults to None.
+        openai_model (Optional[str]): The OpenAI model to use for text generation. Defaults to None.
         default_branch (str): The default branch to push the changes to. Defaults to "main".
 
     Returns:
@@ -408,19 +623,19 @@ def bump(
     if verbose:
         print(f"Current version: {current_version[0]}.{current_version[1]}.{current_version[2]}")
 
-    commits_hashes, commits_messages = get_commits_since_tag(repository_path, last_tag)
-    if not len(commits_hashes):
+    commits = get_commits_since_tag(repository_path, last_tag)
+    if not len(commits):
         raise NoNewCommitsError(f"No new commits since the last {last_tag} tag")
 
     if verbose:
-        print(f"? Commits since last tag: {len(commits_hashes)}")
-        for hash, commit in zip(commits_hashes, commits_messages):
+        print(f"? Commits since last tag: {len(commits)}")
+        for hash, commit in commits:
             print(f"# {hash}: {commit}")
 
-    major_commits, minor_commits, patch_commits = group_commits(commits_messages, major_verbs, minor_verbs, patch_verbs)
+    major_commits, minor_commits, patch_commits = group_commits(commits, major_verbs, minor_verbs, patch_verbs)
     assert (
         len(major_commits) + len(minor_commits) + len(patch_commits)
-    ), "No commit categories found to bump the version: " + ", ".join(commits_messages)
+    ), "No commit categories found to bump the version: " + ", ".join(map(lambda c: c[1], commits))
 
     if len(major_commits):
         bump_type = "major"
@@ -439,17 +654,14 @@ def bump(
     if changelog_file:
         now = datetime.now()
         changes = f"\n## {now:%B %d, %Y}: v{new_version_str}\n"
-        if len(major_commits):
-            changes += f"\n### Major\n\n" + "\n".join(f"- {c}" for c in major_commits) + "\n"
-        if len(minor_commits):
-            changes += f"\n### Minor\n\n" + "\n".join(f"- {c}" for c in minor_commits) + "\n"
-        if len(patch_commits):
-            changes += f"\n### Patch\n\n" + "\n".join(f"- {c}" for c in patch_commits) + "\n"
+        changes += convert_commits_to_message(major_commits, minor_commits, patch_commits)
 
         print(f"Will update file: {changelog_file}")
         if verbose:
             changes_lines = changes.count("\n") + 1
             print(f"? Appending {changes_lines} lines")
+            for line in changes.split("\n"):
+                print(f"+ {line}")
 
         if not dry_run:
             with open(changelog_file, "a") as file:
@@ -468,6 +680,43 @@ def bump(
         for file_path, regex_pattern in update_patch_version_in:
             patch_with_regex(file_path, regex_pattern, str(new_version[2]), dry_run=dry_run, verbose=verbose)
 
+    # Now log the potential issues with the commits
+    if openai_api_key:
+        warnings_commits = []
+        warnings = []
+        changes = [get_diff_for_commit(repository_path, commit.hash) for commit in commits]
+        for commit, change in zip(commits, changes):
+            try:
+                warning = validate_commit_with_llms(
+                    base_url=openai_base_url,
+                    api_key=openai_api_key,
+                    model=openai_model,
+                    commit=commit,
+                    change=change,
+                )
+                if warning:
+                    warnings_commits.append(commit)
+                    warnings.append(warning)
+            except Exception as e:
+                print(f"Failed to validate commit: {commit.hash} with error: {str(e)}")
+                traceback.print_exc()
+
+        if len(warnings):
+            print("## Potential issues")
+            for commit, warning in zip(warnings_commits, warnings):
+                print(f"- Commit #{commit.hash}: {warning}")
+
+        release_notes = aggregate_release_notes_with_llms(
+            base_url=openai_base_url,
+            api_key=openai_api_key,
+            model=openai_model,
+            github_repository=github_repository,
+            commits=commits,
+            changes=changes,
+        )
+        print("## Generated release notes:")
+        print(release_notes)
+
     if not dry_run:
         create_tag(
             repository_path=repository_path,
@@ -479,6 +728,9 @@ def bump(
             github_repository=github_repository,
             push=push,
             create_release=create_release,
+            major_commits=major_commits,
+            minor_commits=minor_commits,
+            patch_commits=patch_commits,
         )
 
 
@@ -582,6 +834,19 @@ def main():
             "--github-repository",
             help="GitHub repository in the 'owner/repo' format, if not set will use GH_REPOSITORY env var",
         )
+        parser.add_argument(
+            "--openai-base-url",
+            default="https://api.openai.com",
+            help="OpenAI API base URL",
+        )
+        parser.add_argument(
+            "--openai-api-key",
+            help="OpenAI API key for text generation",
+        )
+        parser.add_argument(
+            "--openai-model",
+            help="OpenAI model to use for text generation (e.g., 'text-davinci-003' or 'text-davinci-002')",
+        )
         parser.add_argument(
             "--create-release",
             action="store_true",
@@ -629,6 +894,9 @@ def main():
         args.git_user_email = os.environ.get("TINYSEMVER_GIT_USER_EMAIL", "tinysemver@ashvardanian.com")
         args.github_token = os.environ.get("GITHUB_TOKEN")
         args.github_repository = os.environ.get("GITHUB_REPOSITORY")
+        args.openai_base_url = os.environ.get("OPENAI_BASE_URL", "https://api.openai.com")
+        args.openai_api_key = os.environ.get("OPENAI_API_KEY")
+        args.openai_model = os.environ.get("OPENAI_MODEL")
         args.create_release = os.environ.get("TINYSEMVER_CREATE_RELEASE", "").lower() == "true"
 
     # It's common for a CI pipeline to have multiple broken settings or missing files.
@@ -657,6 +925,9 @@ def main():
             git_user_email=args.git_user_email,
             github_token=args.github_token,
             github_repository=args.github_repository,
+            openai_base_url=args.openai_base_url,
+            openai_api_key=args.openai_api_key,
+            openai_model=args.openai_model,
             push=args.push,
             create_release=args.create_release,
         )

{tinysemver-2.0.7 → tinysemver-2.1.0/tinysemver.egg-info}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: tinysemver
-Version: 2.0.7
-Summary: Tiny Semantic Versioning (SemVer) library, that doesn't depend on 300K lines of JavaScript
+Version: 2.1.0
+Summary: Semantic-Versioning with LLMs and without 300,000 lines of JS
 Author-email: Ash Vardanian <1983160+ashvardanian@users.noreply.github.com>, Guillaume de Rouville <31691250+grouville@users.noreply.github.com>
 License:                                  Apache License
                                    Version 2.0, January 2004
@@ -210,7 +210,7 @@ Project-URL: Documentation, https://github.com/ashvardanian/tinysemver/blob/main
 Project-URL: Repository, https://github.com/ashvardanian/tinysemver.git
 Project-URL: Issues, https://github.com/ashvardanian/tinysemver/issues
 Project-URL: Changelog, https://github.com/ashvardanian/tinysemver/blob/main/CHANGELOG.md
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Topic :: Software Development :: Build Tools
 Classifier: License :: OSI Approved :: Apache Software License
@@ -223,10 +223,12 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: openai>=1.54.4
+Requires-Dist: rich>=13.8.0
 
-![](https://github.com/ashvardanian/ashvardanian/blob/master/repositories/TinySemVer.jpg)
+![TinySemVer Banner](https://github.com/ashvardanian/ashvardanian/blob/master/repositories/TinySemVer.jpg)
 
-__TinySemVer__ is a minimalistic [Semantic Versioning](https://semver.org/) package for projects following [Conventional Commits](https://www.conventionalcommits.org/) in a single short Python file.
+__TinySemVer__ is a minimalistic [Semantic Versioning](https://semver.org/) package for projects following [Conventional Commits](https://www.conventionalcommits.org/) in a single short Python file, capable of generating changelogs and release notes with the use of OpenAI-compatible LLM APIs, or without them.
 In plain English, if your commit messages look like `feat: add new feature` or `fix: bugfix`, this package will automate releasing new "GIT tags" based on the commit messages.
 Here is how to integrate it into your project CI:
 
@@ -304,6 +306,19 @@ Alternatively, you can just ask for `--help`:
 $ tinysemver --help
 ```
 
+## AI and Rock-n-Roll
+
+TinySemVer can leverage a language model to validate the commits and generate clean and infromative release notes.
+
+```sh
+$ tinysemver --verbose \
+    --github-repository 'ashvardanian/tinysemver' \
+    --openai-base-url 'https://api.groq.com/openai/v1' \
+    --openai-api-key 'GET_YOURSELF_A_KEY' \
+    --openai-model 'llama-3.2-11b-text-preview' \
+    --dry-run
+```
+
 ## Usage Details for the GitHub CI Action
 
 TinySemVer can be easily integrated into your GitHub Actions CI pipeline.

{tinysemver-2.0.7 → tinysemver-2.1.0}/tinysemver.egg-info/SOURCES.txt

@@ -9,4 +9,5 @@ tinysemver.egg-info/PKG-INFO
 tinysemver.egg-info/SOURCES.txt
 tinysemver.egg-info/dependency_links.txt
 tinysemver.egg-info/entry_points.txt
+tinysemver.egg-info/requires.txt
 tinysemver.egg-info/top_level.txt

tinysemver-2.1.0/tinysemver.egg-info/requires.txt

@@ -0,0 +1,2 @@
+openai>=1.54.4
+rich>=13.8.0