cmt-cli 0.2.0__tar.gz → 1.0.1__tar.gz

cmt_cli-1.0.1/.github/workflows/test.yml

@@ -0,0 +1,30 @@
+name: Tests
+
+on:
+    push:
+        branches: [main]
+        paths:
+            - 'src/**'
+            - 'tests/**'
+            - 'pyproject.toml'
+    pull_request:
+        branches: [main]
+
+jobs:
+    test:
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout code
+              uses: actions/checkout@v4
+
+            - name: Install uv
+              uses: astral-sh/setup-uv@v3
+              with:
+                  enable-cache: true
+
+            - name: Install dependencies
+              run: uv sync --all-groups
+
+            - name: Run tests
+              run: uv run pytest

{cmt_cli-0.2.0 → cmt_cli-1.0.1}/.gitignore

@@ -10,4 +10,6 @@ wheels/
 .venv
 
 # IDE files
-.idea/
+.idea/
+
+scripts

{cmt_cli-0.2.0 → cmt_cli-1.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: cmt-cli
-Version: 0.2.0
+Version: 1.0.1
 Summary: AI-powered Git commit message generator
 Project-URL: Homepage, https://github.com/bijaydas/cmt
 Project-URL: Documentation, https://github.com/bijaydas/cmt#readme
@@ -33,6 +33,7 @@ Description-Content-Type: text/markdown
   <a href="https://pypi.org/project/cmt-cli/"><img src="https://img.shields.io/pypi/pyversions/cmt-cli.svg" alt="Python versions"></a>
   <a href="https://github.com/bijaydas/cmt/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a>
   <img src="https://img.shields.io/badge/status-alpha-orange.svg" alt="Alpha status">
+  <img src="https://img.shields.io/badge/tests-passing-green.svg" alt="Tests">
 </p>
 
 <p>

{cmt_cli-0.2.0 → cmt_cli-1.0.1}/README.md

@@ -9,6 +9,7 @@
   <a href="https://pypi.org/project/cmt-cli/"><img src="https://img.shields.io/pypi/pyversions/cmt-cli.svg" alt="Python versions"></a>
   <a href="https://github.com/bijaydas/cmt/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-MIT-blue.svg" alt="License"></a>
   <img src="https://img.shields.io/badge/status-alpha-orange.svg" alt="Alpha status">
+  <img src="https://img.shields.io/badge/tests-passing-green.svg" alt="Tests">
 </p>
 
 <p>

{cmt_cli-0.2.0 → cmt_cli-1.0.1}/pyproject.toml

@@ -1,14 +1,12 @@
 [project]
 name = "cmt-cli"
-version = "0.2.0"
+version = "1.0.1"
 description = "AI-powered Git commit message generator"
 readme = "README.md"
 requires-python = ">=3.12"
 license = { text = "MIT" }
 license-files = ["LICENSE"]
-authors = [
-    { name = "Bijay Das", email = "me@bijaydas.com" },
-]
+authors = [{ name = "Bijay Das", email = "me@bijaydas.com" }]
 dependencies = [
     "langchain>=1.3.18",
     "langchain-openai>=1.6.0",
@@ -39,10 +37,7 @@ build-backend = "hatchling.build"
 keywords = ["ai", "git", "commit", "message", "generator"]
 
 [dependency-groups]
-dev = [
-    "pytest>=9.1.1",
-    "ruff>=0.16.5",
-]
+dev = ["pytest>=9.1.1", "ruff>=0.16.5"]
 [tool.ruff]
 line-length = 100
 target-version = "py312"
@@ -50,11 +45,11 @@ src = ["src"]
 
 [tool.ruff.lint]
 select = [
-    "E", # pycodestyle errors
-    "F", # pyflakes
-    "I", # isort (import sorting)
-    "UP", # pyupgrade (modern syntax)
-    "B", # flake8-bugbear (common bugs)
+    "E",   # pycodestyle errors
+    "F",   # pyflakes
+    "I",   # isort (import sorting)
+    "UP",  # pyupgrade (modern syntax)
+    "B",   # flake8-bugbear (common bugs)
     "SIM", # flake8-simplify
 ]
 ignore = []

{cmt_cli-0.2.0 → cmt_cli-1.0.1}/src/cmt/ai/cache.py

@@ -2,13 +2,13 @@ import hashlib
 import json
 from pathlib import Path
 
-from cmt.config.settings import Settings
+from cmt.core.settings import settings
 from cmt.models.suggestion import CommitSuggestion
 
 
 class CommitMessageCache:
     def __init__(self):
-        self.cache_dir = Path(Settings().CACHE_DIR)
+        self.cache_dir = Path(settings.CACHE_DIR)
         self.cache_dir.mkdir(parents=True, exist_ok=True)
 
     @staticmethod

{cmt_cli-0.2.0 → cmt_cli-1.0.1}/src/cmt/ai/openai.py

@@ -1,21 +1,29 @@
+import logging
+from typing import cast
+
 from langchain.agents import create_agent
+from langchain.agents.middleware.types import InputAgentState
+from langchain_core.messages import BaseMessage, get_buffer_string
 from langchain_openai import ChatOpenAI
 from pydantic import SecretStr
 
 from cmt.ai.cache import CommitMessageCache
 from cmt.ai.prompt import COMMIT_PROMPT, COMMIT_SYSTEM_PROMPT
 from cmt.ai.provider import AIProvider
-from cmt.config.settings import Settings
+from cmt.core.settings import settings
 from cmt.models.changes import AnalysisResult, StagedChangeSet, StagedFile
 from cmt.models.suggestion import CommitSuggestion
 
+logger = logging.getLogger(__name__)
+
 
 class OpenAIProvider(AIProvider):
     def __init__(self) -> None:
-        settings = Settings()
         self.config = settings.get()
 
-    def _build_prompt(self, changes: StagedChangeSet, analysis: AnalysisResult) -> str:
+    def _build_prompt(
+        self, changes: StagedChangeSet, analysis: AnalysisResult
+    ) -> list[BaseMessage]:
         staged_files = self._process_files(changes.files)
         staged_diffs = changes.diff
 
@@ -37,12 +45,14 @@ class OpenAIProvider(AIProvider):
 
         return output.strip()
 
-    def _invoke(self, prompt: str) -> CommitSuggestion:
+    def _invoke(self, prompt: list[BaseMessage]) -> CommitSuggestion:
         model = ChatOpenAI(
             model=self.config.model,
             api_key=SecretStr(self.config.api_key),
             timeout=30,
-            max_tokens=1200,
+        )
+        logger.info(
+            "Invoking %s model with prompt:\n%s", self.config.model, get_buffer_string(prompt)
         )
 
         agent = create_agent(
@@ -51,7 +61,7 @@ class OpenAIProvider(AIProvider):
             response_format=CommitSuggestion,
         )
 
-        result = agent.invoke({"messages": prompt})
+        result = agent.invoke(cast(InputAgentState, prompt))
 
         return result["structured_response"]
 
@@ -64,13 +74,22 @@ class OpenAIProvider(AIProvider):
         cached_message = cache.get(change_set.diff, self.config.model)
 
         if cached_message:
-            return CommitSuggestion(
+            suggestion = CommitSuggestion(
                 message=cached_message.message, description=cached_message.description
             )
+            logger.info(
+                "Returning cached commit suggestion for the following changes:\n\n%s\n\n"
+                "Commit message: %s",
+                change_set.diff,
+                suggestion.message,
+            )
+            return suggestion
 
         suggestion = self._invoke(prompt)
+        logger.info("Generated new commit suggestion.\n%s", suggestion)
 
         cache.set(change_set.diff, self.config.model, suggestion)
+        logger.info("Cached new commit suggestion.")
 
         return suggestion
 

{cmt_cli-0.2.0 → cmt_cli-1.0.1}/src/cmt/ai/prompt.py

@@ -59,7 +59,13 @@ Renamed: {renamed_files}
 Generate the commit message now.
 """
 
-COMMIT_PROMPT = ChatPromptTemplate.from_messages(
+COMMIT_PROMPT1 = ChatPromptTemplate.from_messages(
+    [
+        ("human", COMMIT_DATA_PROMPT),
+    ]
+)
+
+COMMIT_PROMPT = ChatPromptTemplate(
     [
         ("human", COMMIT_DATA_PROMPT),
     ]

{cmt_cli-0.2.0 → cmt_cli-1.0.1}/src/cmt/cli.py

@@ -1,15 +1,21 @@
-from enum import StrEnum
+import logging
+import sys
 from importlib.metadata import version
 
 import typer
 
 from cmt.ai.openai import OpenAIProvider
 from cmt.analysis.analyzer import Analyzer
-from cmt.config.settings import Config, Settings
+from cmt.core import settings, setup_logging
+from cmt.enums.config import ConfigTask
 from cmt.exceptions import CmtError
 from cmt.git.repository import Repository
+from cmt.schemas.config import AIConfig
+from cmt.services import PyPIService
 from cmt.utils import edit_with_vim
 
+logger = logging.getLogger(__name__)
+
 app = typer.Typer(
     add_completion=False,
 )
@@ -17,7 +23,7 @@ app = typer.Typer(
 
 def version_callback(value: bool) -> None:
     if value:
-        typer.echo(f"cmt-cli version: {version('cmt-cli')}")
+        typer.echo(f"cmt-cli version: {version(settings.APP_NAME)}")
         raise typer.Exit()
 
 
@@ -26,7 +32,9 @@ def main(
     ctx: typer.Context,
     flag: bool = typer.Option(False, "--version", callback=version_callback, is_eager=True),
 ) -> None:
+    setup_logging()
     if ctx.invoked_subcommand is None:
+        logger.info("No subcommand invoked, displaying help.")
         typer.echo(ctx.get_help())
         raise typer.Exit(code=0)
 
@@ -39,11 +47,15 @@ def suggest() -> None:
         analyzer = Analyzer()
 
         if not repository.is_git_repository():
+            logger.error("Not a git repository.")
             raise CmtError("Not a git repository.")
 
         staged_files = repository.get_staged_changes()
 
         if not staged_files.files:
+            logger.warning(
+                "No staged files found. Please stage your changes before running this command."
+            )
             typer.echo(
                 "No staged files found. Please stage your changes before running this command."
             )
@@ -56,6 +68,7 @@ def suggest() -> None:
         commit = open_ai.generate_commit_message(staged_files, analysis_result)
         commit_command = OpenAIProvider.commit_command(commit)
 
+        logger.info("Suggested commit:\n\n%s", commit_command)
         typer.echo(f"Suggested commit:\n\n{commit_command}")
 
         while True:
@@ -74,7 +87,10 @@ def suggest() -> None:
                 typer.echo(f"Edited commit:\n\n{commit_command}")
 
             if action == "y":
+                logger.info("Committing with message:\n\n%s", commit_command)
                 result = repository.commit(commit_command)
+
+                logger.info("Commit result:\n\n%s", result.stdout)
                 typer.echo(f"Commit result:\n\n{result.stdout}")
                 break
 
@@ -84,32 +100,27 @@ def suggest() -> None:
     except typer.Exit:
         raise
     except KeyboardInterrupt:
+        logger.info("Operation cancelled by user.")
         typer.echo("\nOperation cancelled by user.", err=True)
         raise typer.Exit(code=1) from None
     except Exception as e:
+        logger.error("Unexpected error: %s", e)
         typer.echo(f"Unexpected error: {e}", err=True)
         raise typer.Exit(code=1) from None
 
 
-class ConfigTask(StrEnum):
-    set = "set"
-    get = "get"
-
-
 @app.command()
 def config(task: ConfigTask) -> None:
     """Configure cmt-cli configuration for OpenAI API key and model."""
     if task == ConfigTask.set:
-        settings = Settings()
-
         open_ai_key = typer.prompt("Enter your OpenAI API key", default=None)
         open_ai_model = typer.prompt(
             "Enter your OpenAI model", default=settings.OPEN_AI_DEFAULT_MODEL
         )
-        settings.set(Config(api_key=open_ai_key, model=open_ai_model))
+        logger.info("Configuration updated with OpenAI API key and model.")
+        settings.set(AIConfig(api_key=open_ai_key, model=open_ai_model))
 
     if task == ConfigTask.get:
-        settings = Settings()
         setting_values = settings.get()
 
         if setting_values.api_key:
@@ -118,8 +129,42 @@ def config(task: ConfigTask) -> None:
         if setting_values.model:
             typer.echo(f"OpenAI model: {setting_values.model}")
 
+        logger.info("Retrieved current configuration.")
+
         raise typer.Exit(code=0)
 
 
+@app.command()
+def update() -> None:
+    """Update cmt-cli to the latest version."""
+    logger.info("Starting update process for %s.", settings.APP_NAME)
+
+    current_version = version(settings.APP_NAME)
+    logger.info("Current %s version: %s", settings.APP_NAME, current_version)
+
+    pypi_service = PyPIService()
+    latest_info_response = pypi_service.any_update(current_version=current_version)
+
+    if latest_info_response.updated_required:
+        logger.info(
+            "Update required: current version %s, latest version %s",
+            latest_info_response.current_version,
+            latest_info_response.latest_version,
+        )
+        typer.echo(
+            f"A new version of {settings.APP_NAME} is available: "
+            f"{latest_info_response.latest_version}.\n\n"
+            f"upgrade {settings.APP_NAME} using your package manager.",
+        )
+    else:
+        logger.info(
+            "No update required. You are using the latest version: %s",
+            latest_info_response.current_version,
+        )
+        typer.echo(f"You are using the latest version of {settings.APP_NAME}")
+
+    raise typer.Exit(code=0)
+
+
 if __name__ == "__main__":
     app()

cmt_cli-1.0.1/src/cmt/core/__init__.py

@@ -0,0 +1,4 @@
+from cmt.core.logging import setup_logging
+from cmt.core.settings import settings
+
+__all__ = ["settings", "setup_logging"]

cmt_cli-1.0.1/src/cmt/core/logging.py

@@ -0,0 +1,18 @@
+import logging
+from logging.handlers import RotatingFileHandler
+
+from cmt.core.settings import settings
+
+
+def setup_logging():
+    settings.LOGS_DIR.mkdir(parents=True, exist_ok=True)
+
+    handler = RotatingFileHandler(
+        settings.LOGS_DIR / f"{settings.APP_NAME}.log", maxBytes=1024 * 1024, backupCount=9
+    )
+
+    logging.basicConfig(
+        level=logging.DEBUG,
+        format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
+        handlers=[handler],
+    )

{cmt_cli-0.2.0/src/cmt/config → cmt_cli-1.0.1/src/cmt/core}/settings.py

@@ -1,24 +1,20 @@
 from configparser import ConfigParser
 from pathlib import Path
 
-from pydantic import BaseModel
-
 from cmt.exceptions import ConfigurationError
-
-
-class Config(BaseModel):
-    api_key: str
-    model: str
+from cmt.schemas.config import AIConfig
 
 
 class Settings:
+    APP_NAME: str = "cmt-cli"
     CONFIG_DIR: Path = Path.home() / ".config" / "cmt"
     CACHE_DIR: Path = CONFIG_DIR / "cache"
+    LOGS_DIR: Path = CONFIG_DIR / "logs"
 
     CONFIG_FILE: Path = CONFIG_DIR / "config.ini"
     OPEN_AI_DEFAULT_MODEL: str = "gpt-4o-mini"
 
-    def set(self, openai_config: Config):
+    def set(self, openai_config: AIConfig):
         self.CONFIG_DIR.mkdir(parents=True, exist_ok=True)
 
         config = ConfigParser()
@@ -35,7 +31,7 @@ class Settings:
         with open(self.CONFIG_FILE, "w") as f:
             config.write(f)
 
-    def get(self) -> Config:
+    def get(self) -> AIConfig:
         if not self.CONFIG_FILE.exists():
             raise FileNotFoundError(
                 "Configuration file not found. Run `cmt config set` to set it up."
@@ -57,4 +53,7 @@ class Settings:
                 "Model not found in the configuration. Run `cmt config set` to set it up."
             )
 
-        return Config(api_key=api_key, model=model)
+        return AIConfig(api_key=api_key, model=model)
+
+
+settings = Settings()

cmt_cli-1.0.1/src/cmt/enums/config.py

@@ -0,0 +1,6 @@
+from enum import StrEnum
+
+
+class ConfigTask(StrEnum):
+    set = "set"
+    get = "get"

cmt_cli-1.0.1/src/cmt/schemas/config.py

@@ -0,0 +1,6 @@
+from pydantic import BaseModel
+
+
+class AIConfig(BaseModel):
+    api_key: str
+    model: str

cmt_cli-1.0.1/src/cmt/schemas/general.py

@@ -0,0 +1,7 @@
+from pydantic import BaseModel
+
+
+class VersionInfo(BaseModel):
+    current_version: str
+    latest_version: str
+    updated_required: bool

cmt_cli-1.0.1/src/cmt/services/__init__.py

@@ -0,0 +1,3 @@
+from cmt.services.pypi import PyPIService
+
+__all__ = ["PyPIService"]

cmt_cli-1.0.1/src/cmt/services/pypi.py

@@ -0,0 +1,34 @@
+import logging
+
+import httpx
+
+from cmt.core import settings
+from cmt.schemas.general import VersionInfo
+
+logger = logging.getLogger(__name__)
+
+
+class PyPIService:
+    def __init__(self):
+        self._base_url = "https://pypi.org/pypi"
+
+    def _get_package_info(self) -> dict:
+        url = f"{self._base_url}/{settings.APP_NAME}/json"
+        response = httpx.get(url)
+
+        logger.debug("Received response with status code: %s", response.status_code)
+        response.raise_for_status()
+
+        return response.json()
+
+    def any_update(self, current_version: str) -> VersionInfo:
+        latest_info = self._get_package_info()
+        latest_version = latest_info["info"]["version"]
+
+        logger.debug("Current version: %s, Latest version: %s", current_version, latest_version)
+
+        return VersionInfo(
+            current_version=current_version,
+            latest_version=latest_version,
+            updated_required=latest_version != current_version,
+        )

cmt_cli-0.2.0/.github/workflows/test.yml

@@ -1,27 +0,0 @@
-name: Tests
-
-on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-
-      - name: Install uv
-        uses: astral-sh/setup-uv@v3
-        with:
-          python-version: "3.12"
-          enable-cache: true
-
-      - name: Install dependencies
-        run: uv sync --all-groups
-
-      - name: Run tests
-        run: uv run pytest