gitme-ai 0.1.0__tar.gz

gitme_ai-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 RohitB2005
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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 OR COPYRIGHT HOLDERS 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.

gitme_ai-0.1.0/PKG-INFO

@@ -0,0 +1,247 @@
+Metadata-Version: 2.4
+Name: gitme-ai
+Version: 0.1.0
+Summary: AI-powered git commit message generator
+Author-email: Rohit Balaji <rohitvb26@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/RohitB2005/gitme-cli
+Project-URL: Repository, https://github.com/RohitB2005/gitme-cli
+Project-URL: Bug Tracker, https://github.com/RohitB2005/gitme-cli/issues
+Keywords: git,cli,ai,commit,llm,developer-tools
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0
+Requires-Dist: rich>=13.0
+Requires-Dist: pyperclip>=1.8
+Requires-Dist: requests>=2.28
+Requires-Dist: tomli-w>=1.0
+Dynamic: license-file
+
+# gitme-cli
+
+AI-powered git commit message generator. Reads your staged changes and generates a well-formatted [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) message using a local or cloud LLM.
+
+**Local-first and privacy-friendly by default** — your diffs never leave your machine unless you choose a cloud provider.
+
+---
+
+## Requirements
+
+- Python 3.11 or higher
+- Git
+
+---
+
+## Installation
+
+```bash
+pip install gitme-cli
+```
+
+---
+
+## Quick Start
+
+Stage your changes as you normally would, then run `gitme`:
+
+```bash
+git add .
+gitme
+```
+
+That's it. gitme reads your staged diff, sends it to the AI, and prints a suggested commit message in your terminal.
+
+By default it uses **Ollama with llama3.2** running locally. See [Providers](#providers) below to set up Ollama or switch to a cloud provider.
+
+---
+
+## Usage
+
+### Basic
+
+```bash
+gitme
+```
+
+### Copy to clipboard
+
+```bash
+gitme --copy
+```
+
+The message is printed to the terminal and copied to your clipboard. You can then paste it directly into `git commit -m "..."`.
+
+### Add extra context
+
+```bash
+gitme --context "this is a hotfix for the login bug in production"
+```
+
+The context is appended to the prompt so the model has more information to work with. Useful when the diff alone doesn't tell the full story.
+
+---
+
+## Providers
+
+gitme supports three providers. You set your preferred one once and it applies to every future run.
+
+### Ollama (default — local, free, private)
+
+Ollama runs models on your own machine. No API key needed, no data leaves your computer.
+
+**1. Install Ollama**
+
+Download from [ollama.com](https://ollama.com) and open the app. You'll see it in your menu bar when it's running.
+
+**2. Pull the model**
+
+```bash
+ollama pull llama3.2
+```
+
+**3. Run gitme**
+
+```bash
+gitme
+```
+
+Ollama is already the default — nothing else to configure.
+
+To use a different Ollama model:
+
+```bash
+gitme-config set model mistral
+```
+
+---
+
+### OpenAI (cloud, best quality)
+
+Uses the OpenAI API. You need an API key and credit — `gpt-4o-mini` is cheap and works well for commit messages.
+
+**1. Set your API key**
+
+```bash
+gitme-config set openai_api_key YOUR_API_KEY
+gitme-config set provider openai
+gitme-config set model gpt-4o-mini
+```
+
+**2. Run gitme**
+
+```bash
+gitme
+```
+
+Your API key is stored locally in `~/.gitme.toml` and never shared.
+
+---
+
+### OpenRouter (cloud, free tier available)
+
+OpenRouter provides access to many models including free ones. No credit card required for the free tier.
+
+Get a free API key at [openrouter.ai](https://openrouter.ai).
+
+**1. Set your API key**
+
+```bash
+gitme-config set openrouter_api_key YOUR_API_KEY
+gitme-config set provider openrouter
+gitme-config set model "nvidia/nemotron-3-nano-30b-a3b:free"
+```
+
+**2. Run gitme**
+
+```bash
+gitme
+```
+
+---
+
+## Configuration
+
+Configuration is stored in `~/.gitme.toml` and shared across all your projects.
+
+### View current config
+
+```bash
+gitme-config show
+```
+
+Output:
+```
+provider: ollama
+model: llama3.2
+style: conventional
+```
+
+### Set a value
+
+```bash
+gitme-config set <key> <value>
+```
+
+**Available keys:**
+
+| Key | Description | Default |
+|-----|-------------|---------|
+| `provider` | Which provider to use: `ollama`, `openai`, or `openrouter` | `ollama` |
+| `model` | Model name for the active provider | `llama3.2` |
+| `style` | Commit style (currently `conventional`) | `conventional` |
+| `openai_api_key` | Your OpenAI API key | — |
+| `openrouter_api_key` | Your OpenRouter API key | — |
+
+### Examples
+
+```bash
+# Switch to OpenAI
+gitme-config set provider openai
+gitme-config set model gpt-4o-mini
+gitme-config set openai_api_key sk-...
+
+# Switch back to Ollama
+gitme-config set provider ollama
+gitme-config set model llama3.2
+```
+
+---
+
+## Commit Format
+
+gitme follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) specification:
+
+```
+type(scope): short description
+
+- optional body explaining why the change was made
+
+Fixes #123  (optional footer)
+```
+
+**Commit types:**
+
+| Type | When to use |
+|------|-------------|
+| `feat` | New feature or capability |
+| `fix` | Bug fix |
+| `refactor` | Code restructured without changing behaviour |
+| `docs` | Documentation changes only |
+| `style` | Formatting or whitespace, no logic changes |
+| `test` | Adding or updating tests |
+| `chore` | Maintenance, config changes, dependency updates |
+
+---
+
+## License
+
+MIT

gitme_ai-0.1.0/README.md

@@ -0,0 +1,219 @@
+# gitme-cli
+
+AI-powered git commit message generator. Reads your staged changes and generates a well-formatted [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) message using a local or cloud LLM.
+
+**Local-first and privacy-friendly by default** — your diffs never leave your machine unless you choose a cloud provider.
+
+---
+
+## Requirements
+
+- Python 3.11 or higher
+- Git
+
+---
+
+## Installation
+
+```bash
+pip install gitme-cli
+```
+
+---
+
+## Quick Start
+
+Stage your changes as you normally would, then run `gitme`:
+
+```bash
+git add .
+gitme
+```
+
+That's it. gitme reads your staged diff, sends it to the AI, and prints a suggested commit message in your terminal.
+
+By default it uses **Ollama with llama3.2** running locally. See [Providers](#providers) below to set up Ollama or switch to a cloud provider.
+
+---
+
+## Usage
+
+### Basic
+
+```bash
+gitme
+```
+
+### Copy to clipboard
+
+```bash
+gitme --copy
+```
+
+The message is printed to the terminal and copied to your clipboard. You can then paste it directly into `git commit -m "..."`.
+
+### Add extra context
+
+```bash
+gitme --context "this is a hotfix for the login bug in production"
+```
+
+The context is appended to the prompt so the model has more information to work with. Useful when the diff alone doesn't tell the full story.
+
+---
+
+## Providers
+
+gitme supports three providers. You set your preferred one once and it applies to every future run.
+
+### Ollama (default — local, free, private)
+
+Ollama runs models on your own machine. No API key needed, no data leaves your computer.
+
+**1. Install Ollama**
+
+Download from [ollama.com](https://ollama.com) and open the app. You'll see it in your menu bar when it's running.
+
+**2. Pull the model**
+
+```bash
+ollama pull llama3.2
+```
+
+**3. Run gitme**
+
+```bash
+gitme
+```
+
+Ollama is already the default — nothing else to configure.
+
+To use a different Ollama model:
+
+```bash
+gitme-config set model mistral
+```
+
+---
+
+### OpenAI (cloud, best quality)
+
+Uses the OpenAI API. You need an API key and credit — `gpt-4o-mini` is cheap and works well for commit messages.
+
+**1. Set your API key**
+
+```bash
+gitme-config set openai_api_key YOUR_API_KEY
+gitme-config set provider openai
+gitme-config set model gpt-4o-mini
+```
+
+**2. Run gitme**
+
+```bash
+gitme
+```
+
+Your API key is stored locally in `~/.gitme.toml` and never shared.
+
+---
+
+### OpenRouter (cloud, free tier available)
+
+OpenRouter provides access to many models including free ones. No credit card required for the free tier.
+
+Get a free API key at [openrouter.ai](https://openrouter.ai).
+
+**1. Set your API key**
+
+```bash
+gitme-config set openrouter_api_key YOUR_API_KEY
+gitme-config set provider openrouter
+gitme-config set model "nvidia/nemotron-3-nano-30b-a3b:free"
+```
+
+**2. Run gitme**
+
+```bash
+gitme
+```
+
+---
+
+## Configuration
+
+Configuration is stored in `~/.gitme.toml` and shared across all your projects.
+
+### View current config
+
+```bash
+gitme-config show
+```
+
+Output:
+```
+provider: ollama
+model: llama3.2
+style: conventional
+```
+
+### Set a value
+
+```bash
+gitme-config set <key> <value>
+```
+
+**Available keys:**
+
+| Key | Description | Default |
+|-----|-------------|---------|
+| `provider` | Which provider to use: `ollama`, `openai`, or `openrouter` | `ollama` |
+| `model` | Model name for the active provider | `llama3.2` |
+| `style` | Commit style (currently `conventional`) | `conventional` |
+| `openai_api_key` | Your OpenAI API key | — |
+| `openrouter_api_key` | Your OpenRouter API key | — |
+
+### Examples
+
+```bash
+# Switch to OpenAI
+gitme-config set provider openai
+gitme-config set model gpt-4o-mini
+gitme-config set openai_api_key sk-...
+
+# Switch back to Ollama
+gitme-config set provider ollama
+gitme-config set model llama3.2
+```
+
+---
+
+## Commit Format
+
+gitme follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) specification:
+
+```
+type(scope): short description
+
+- optional body explaining why the change was made
+
+Fixes #123  (optional footer)
+```
+
+**Commit types:**
+
+| Type | When to use |
+|------|-------------|
+| `feat` | New feature or capability |
+| `fix` | Bug fix |
+| `refactor` | Code restructured without changing behaviour |
+| `docs` | Documentation changes only |
+| `style` | Formatting or whitespace, no logic changes |
+| `test` | Adding or updating tests |
+| `chore` | Maintenance, config changes, dependency updates |
+
+---
+
+## License
+
+MIT

gitme_ai-0.1.0/gitme/cli.py

@@ -0,0 +1,91 @@
+import click
+from rich.console import Console
+from rich.panel import Panel
+
+from .diff import get_staged_diff
+from .prompt import SYSTEM_PROMPT, build_prompt
+from .providers.ollama import OllamaProvider
+from .providers.openai import OpenAIProvider
+from .providers.openrouter import OpenRouterProvider
+from .config import load_config, save_config, show_config
+
+console = Console()
+
+
+def get_provider(cfg: dict):
+    provider = cfg.get("provider", "ollama")
+    model = cfg.get("model", "llama3.2")
+
+    if provider == "ollama":
+        return OllamaProvider(model=model)
+    elif provider == "openai":
+        return OpenAIProvider(model=model, api_key=cfg.get("openai_api_key", ""))
+    elif provider == "openrouter":
+        return OpenRouterProvider(model=model, api_key=cfg.get("openrouter_api_key", ""))
+    else:
+        raise RuntimeError(
+            f"Unknown provider '{provider}'. Choose: ollama, openai, openrouter"
+        )
+
+
+@click.command()
+@click.option("--copy", is_flag=True, help="Copy the result to clipboard.")
+@click.option("--context", default="", help="Extra context to include in the prompt.")
+def main(copy, context):
+    """Generate a git commit message from your staged changes."""
+    try:
+        diff = get_staged_diff()
+    except (EnvironmentError, ValueError) as e:
+        console.print(f"[red]Error:[/red] {e}")
+        raise SystemExit(1)
+
+    user_prompt = build_prompt(diff)
+    if context:
+        user_prompt += f"\n\nExtra context: {context}"
+
+    console.print("[dim]Generating commit message...[/dim]")
+
+    try:
+        cfg = load_config()
+        provider = get_provider(cfg)
+        message = provider.generate(SYSTEM_PROMPT, user_prompt)
+    except RuntimeError as e:
+        console.print(f"[red]Error:[/red] {e}")
+        raise SystemExit(1)
+
+    console.print(Panel(message, title="suggested commit message", border_style="green"))
+
+    if copy:
+        try:
+            import pyperclip
+            pyperclip.copy(message)
+            console.print("[dim]Copied to clipboard.[/dim]")
+        except Exception:
+            console.print("[yellow]Could not copy to clipboard.[/yellow]")
+
+
+@click.group()
+def config():
+    """Manage gitme configuration."""
+    pass
+
+
+@config.command("set")
+@click.argument("key")
+@click.argument("value")
+def config_set(key, value):
+    """Set a config value. E.g: gitme-config set provider openai"""
+    valid_keys = ["provider", "model", "style", "openai_api_key", "openrouter_api_key"]
+    if key not in valid_keys:
+        console.print(f"[red]Unknown key '{key}'. Valid keys: {', '.join(valid_keys)}[/red]")
+        raise SystemExit(1)
+    save_config({key: value})
+    console.print(f"[green]Set {key} = {value}[/green]")
+
+
+@config.command("show")
+def config_show():
+    """Show current configuration."""
+    cfg = show_config()
+    for key, value in cfg.items():
+        console.print(f"[dim]{key}:[/dim] {value}", highlight=False)

gitme_ai-0.1.0/gitme/config.py

@@ -0,0 +1,31 @@
+import tomllib
+import tomli_w
+from pathlib import Path
+
+CONFIG_PATH = Path.home() / ".gitme.toml"
+
+DEFAULTS = {
+    "provider": "ollama",
+    "model": "llama3.2",
+    "style": "conventional",
+}
+
+def load_config() -> dict:
+    if not CONFIG_PATH.exists():
+        return DEFAULTS.copy()
+    
+    with open(CONFIG_PATH, "rb") as f:
+        user_config = tomllib.load(f)
+    
+    return {**DEFAULTS, **user_config}
+
+def save_config(updates: dict) -> None:
+    config = load_config()
+    config.update(updates)
+
+    with open(CONFIG_PATH, "wb") as f:
+        tomli_w.dump(config, f)
+
+
+def show_config() -> dict:
+    return load_config()

gitme_ai-0.1.0/gitme/diff.py

@@ -0,0 +1,27 @@
+import subprocess
+
+def get_staged_diff() -> str:
+    repo_exists = subprocess.run(
+        ["git", "rev-parse", "--is-inside-work-tree"],
+        capture_output=True,
+        text=True
+    )
+
+    if repo_exists.returncode != 0:
+        raise EnvironmentError("Not currently inside a git repository.")
+    
+    result = subprocess.run(
+        ["git", "diff", "--cached"],
+        capture_output=True,
+        text=True
+    )
+
+    if result.returncode != 0:
+        raise RuntimeError(f"Git error: {result.stderr.strip()}")
+    
+    diff = result.stdout.strip()
+
+    if not diff:
+        raise ValueError("No staged changes found. Run 'git add' first.")
+    
+    return diff

gitme_ai-0.1.0/gitme/prompt.py

@@ -0,0 +1,40 @@
+SYSTEM_PROMPT = """You are an expert software engineer writing a git commit message based on staged changes from a git diff.
+
+Your output MUST follow the Conventional Commits specification.
+
+Subject line rules:
+- format: type(scope): description
+- type must be one of: feat, fix, refactor, docs, style, test, chore
+- scope is optional — only include it if changes target one clear area, never use a filename
+- less than 72 characters, imperative mood ("add" not "adds" or "added"), no trailing period
+- description must capture intent, not list what files changed
+
+Commit types:
+- feat:     introduces a new feature or capability
+- fix:      patches a bug or error
+- refactor: restructures code without changing behaviour or fixing a bug
+- docs:     documentation changes only, no logic changes
+- style:    formatting or whitespace only, no logic changes
+- test:     adding or updating tests only
+- chore:    maintenance, config changes, dependency updates
+
+Body rules:
+- omit the body entirely unless the WHY behind the change is genuinely non-obvious
+- if included, start one blank line after the subject line
+- write 2-4 bullet points explaining WHY, not what was changed
+- do NOT mention filenames, function names, variable names, or command names
+- do NOT use filler words or opinions ("intuitive", "user-friendly", "clean")
+
+Footer rules:
+- omit the footer entirely unless there is a real breaking change or a real issue reference
+- BREAKING CHANGE only applies if existing users' workflows would break — adding features never qualifies
+- do NOT invent issue numbers — only include "Fixes #N" if the diff references a real issue
+- "No breaking changes" is NOT a valid footer — omit the footer entirely instead
+
+Output rules:
+- output the commit message only
+- no explanations, no preamble, no markdown code fences"""
+
+
+def build_prompt(diff: str) -> str:
+    return f"Here is the staged git diff to write a commit message for:\n\n{diff}"

gitme_ai-0.1.0/gitme/providers/base.py

@@ -0,0 +1,8 @@
+from abc import ABC, abstractmethod
+
+class BaseProvider(ABC):
+
+    @abstractmethod
+    def generate(self, system_prompt: str, user_prompt: str) -> str:
+        """Send prompts to the LLM and return commit message."""
+        pass

gitme_ai-0.1.0/gitme/providers/ollama.py

@@ -0,0 +1,33 @@
+import requests
+from .base import BaseProvider
+
+
+class OllamaProvider(BaseProvider):
+
+    def __init__(self, model: str = "llama3.2"):
+        self.model = model
+        self.url = "http://127.0.0.1:11434/api/chat"
+
+    def generate(self, system_prompt: str, user_prompt: str) -> str:
+        payload = {
+            "model": self.model,
+            "stream": False,
+            "messages": [
+                {"role": "system", "content": system_prompt},
+                {"role": "user",   "content": user_prompt},
+            ]
+        }
+
+        try:
+            response = requests.post(self.url, json=payload, timeout=60)
+            response.raise_for_status()
+        except requests.exceptions.ConnectionError:
+            raise RuntimeError(
+                "Could not connect to Ollama. Is it running? Try: ollama serve"
+            )
+        except requests.exceptions.Timeout:
+            raise RuntimeError(
+                "Ollama took too long to respond. Try a smaller model."
+            )
+
+        return response.json()["message"]["content"].strip()

gitme_ai-0.1.0/gitme/providers/openai.py

@@ -0,0 +1,43 @@
+import requests
+from .base import BaseProvider
+
+class OpenAIProvider(BaseProvider):
+
+    def __init__(self, model: str = "gpt-4o-mini", api_key: str = ""):
+        self.model = model
+        self.api_key = api_key
+        self.url = "https://api.openai.com/v1/chat/completions"
+
+    def generate(self, system_prompt: str, user_prompt: str) -> str:
+        if not self.api_key:
+            raise RuntimeError(
+                "No OpenAI API key set. Run: gitme-config set openai_api_key YOUR_KEY"
+            )
+        
+        headers = {
+            "Authorization": f"Bearer {self.api_key}",
+            "Content-Type": "application/json",
+        }
+        payload = {
+            "model": self.model,
+            "messages": [
+                {"role": "system", "content": system_prompt},
+                {"role": "user",   "content": user_prompt},
+            ]
+        }
+
+        try:
+            response = requests.post(self.url, json=payload, headers=headers, timeout=30)
+            response.raise_for_status()
+        except requests.exceptions.ConnectionError:
+            raise RuntimeError("Could not connect to OpenAI. Check your internet connection.")
+        except requests.exceptions.Timeout:
+            raise RuntimeError("OpenAI took too long to respond.")
+        except requests.exceptions.HTTPError as e:
+            if response.status_code == 401:
+                raise RuntimeError("Invalid OpenAI API key.")
+            if response.status_code == 429:
+                raise RuntimeError("OpenAI rate limit hit. Wait a moment and try again.")
+            raise RuntimeError(f"OpenAI error: {e}")
+
+        return response.json()["choices"][0]["message"]["content"].strip()

gitme_ai-0.1.0/gitme/providers/openrouter.py

@@ -0,0 +1,44 @@
+import requests
+from .base import BaseProvider
+
+
+class OpenRouterProvider(BaseProvider):
+
+    def __init__(self, model: str = "nvidia/nemotron-3-nano-30b-a3b:free", api_key: str = ""):
+        self.model = model
+        self.api_key = api_key
+        self.url = "https://openrouter.ai/api/v1/chat/completions"
+
+    def generate(self, system_prompt: str, user_prompt: str) -> str:
+        if not self.api_key:
+            raise RuntimeError(
+                "No OpenRouter API key set. Run: gitme-config set openrouter_api_key YOUR_KEY"
+            )
+
+        headers = {
+            "Authorization": f"Bearer {self.api_key}",
+            "Content-Type": "application/json",
+        }
+        payload = {
+            "model": self.model,
+            "messages": [
+                {"role": "system", "content": system_prompt},
+                {"role": "user",   "content": user_prompt},
+            ]
+        }
+
+        try:
+            response = requests.post(self.url, json=payload, headers=headers, timeout=30)
+            response.raise_for_status()
+        except requests.exceptions.ConnectionError:
+            raise RuntimeError("Could not connect to OpenRouter. Check your internet connection.")
+        except requests.exceptions.Timeout:
+            raise RuntimeError("OpenRouter took too long to respond.")
+        except requests.exceptions.HTTPError as e:
+            if response.status_code == 401:
+                raise RuntimeError("Invalid OpenRouter API key.")
+            if response.status_code == 429:
+                raise RuntimeError("OpenRouter rate limit hit. Wait a moment and try again.")
+            raise RuntimeError(f"OpenRouter error: {e}")
+
+        return response.json()["choices"][0]["message"]["content"].strip()

gitme_ai-0.1.0/gitme_ai.egg-info/PKG-INFO

@@ -0,0 +1,247 @@
+Metadata-Version: 2.4
+Name: gitme-ai
+Version: 0.1.0
+Summary: AI-powered git commit message generator
+Author-email: Rohit Balaji <rohitvb26@gmail.com>
+License: MIT
+Project-URL: Homepage, https://github.com/RohitB2005/gitme-cli
+Project-URL: Repository, https://github.com/RohitB2005/gitme-cli
+Project-URL: Bug Tracker, https://github.com/RohitB2005/gitme-cli/issues
+Keywords: git,cli,ai,commit,llm,developer-tools
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Version Control :: Git
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.0
+Requires-Dist: rich>=13.0
+Requires-Dist: pyperclip>=1.8
+Requires-Dist: requests>=2.28
+Requires-Dist: tomli-w>=1.0
+Dynamic: license-file
+
+# gitme-cli
+
+AI-powered git commit message generator. Reads your staged changes and generates a well-formatted [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) message using a local or cloud LLM.
+
+**Local-first and privacy-friendly by default** — your diffs never leave your machine unless you choose a cloud provider.
+
+---
+
+## Requirements
+
+- Python 3.11 or higher
+- Git
+
+---
+
+## Installation
+
+```bash
+pip install gitme-cli
+```
+
+---
+
+## Quick Start
+
+Stage your changes as you normally would, then run `gitme`:
+
+```bash
+git add .
+gitme
+```
+
+That's it. gitme reads your staged diff, sends it to the AI, and prints a suggested commit message in your terminal.
+
+By default it uses **Ollama with llama3.2** running locally. See [Providers](#providers) below to set up Ollama or switch to a cloud provider.
+
+---
+
+## Usage
+
+### Basic
+
+```bash
+gitme
+```
+
+### Copy to clipboard
+
+```bash
+gitme --copy
+```
+
+The message is printed to the terminal and copied to your clipboard. You can then paste it directly into `git commit -m "..."`.
+
+### Add extra context
+
+```bash
+gitme --context "this is a hotfix for the login bug in production"
+```
+
+The context is appended to the prompt so the model has more information to work with. Useful when the diff alone doesn't tell the full story.
+
+---
+
+## Providers
+
+gitme supports three providers. You set your preferred one once and it applies to every future run.
+
+### Ollama (default — local, free, private)
+
+Ollama runs models on your own machine. No API key needed, no data leaves your computer.
+
+**1. Install Ollama**
+
+Download from [ollama.com](https://ollama.com) and open the app. You'll see it in your menu bar when it's running.
+
+**2. Pull the model**
+
+```bash
+ollama pull llama3.2
+```
+
+**3. Run gitme**
+
+```bash
+gitme
+```
+
+Ollama is already the default — nothing else to configure.
+
+To use a different Ollama model:
+
+```bash
+gitme-config set model mistral
+```
+
+---
+
+### OpenAI (cloud, best quality)
+
+Uses the OpenAI API. You need an API key and credit — `gpt-4o-mini` is cheap and works well for commit messages.
+
+**1. Set your API key**
+
+```bash
+gitme-config set openai_api_key YOUR_API_KEY
+gitme-config set provider openai
+gitme-config set model gpt-4o-mini
+```
+
+**2. Run gitme**
+
+```bash
+gitme
+```
+
+Your API key is stored locally in `~/.gitme.toml` and never shared.
+
+---
+
+### OpenRouter (cloud, free tier available)
+
+OpenRouter provides access to many models including free ones. No credit card required for the free tier.
+
+Get a free API key at [openrouter.ai](https://openrouter.ai).
+
+**1. Set your API key**
+
+```bash
+gitme-config set openrouter_api_key YOUR_API_KEY
+gitme-config set provider openrouter
+gitme-config set model "nvidia/nemotron-3-nano-30b-a3b:free"
+```
+
+**2. Run gitme**
+
+```bash
+gitme
+```
+
+---
+
+## Configuration
+
+Configuration is stored in `~/.gitme.toml` and shared across all your projects.
+
+### View current config
+
+```bash
+gitme-config show
+```
+
+Output:
+```
+provider: ollama
+model: llama3.2
+style: conventional
+```
+
+### Set a value
+
+```bash
+gitme-config set <key> <value>
+```
+
+**Available keys:**
+
+| Key | Description | Default |
+|-----|-------------|---------|
+| `provider` | Which provider to use: `ollama`, `openai`, or `openrouter` | `ollama` |
+| `model` | Model name for the active provider | `llama3.2` |
+| `style` | Commit style (currently `conventional`) | `conventional` |
+| `openai_api_key` | Your OpenAI API key | — |
+| `openrouter_api_key` | Your OpenRouter API key | — |
+
+### Examples
+
+```bash
+# Switch to OpenAI
+gitme-config set provider openai
+gitme-config set model gpt-4o-mini
+gitme-config set openai_api_key sk-...
+
+# Switch back to Ollama
+gitme-config set provider ollama
+gitme-config set model llama3.2
+```
+
+---
+
+## Commit Format
+
+gitme follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.2/) specification:
+
+```
+type(scope): short description
+
+- optional body explaining why the change was made
+
+Fixes #123  (optional footer)
+```
+
+**Commit types:**
+
+| Type | When to use |
+|------|-------------|
+| `feat` | New feature or capability |
+| `fix` | Bug fix |
+| `refactor` | Code restructured without changing behaviour |
+| `docs` | Documentation changes only |
+| `style` | Formatting or whitespace, no logic changes |
+| `test` | Adding or updating tests |
+| `chore` | Maintenance, config changes, dependency updates |
+
+---
+
+## License
+
+MIT

gitme_ai-0.1.0/gitme_ai.egg-info/SOURCES.txt

@@ -0,0 +1,20 @@
+LICENSE
+README.md
+pyproject.toml
+gitme/__init__.py
+gitme/cli.py
+gitme/config.py
+gitme/diff.py
+gitme/prompt.py
+gitme/providers/__init__.py
+gitme/providers/base.py
+gitme/providers/ollama.py
+gitme/providers/openai.py
+gitme/providers/openrouter.py
+gitme_ai.egg-info/PKG-INFO
+gitme_ai.egg-info/SOURCES.txt
+gitme_ai.egg-info/dependency_links.txt
+gitme_ai.egg-info/requires.txt
+gitme_ai.egg-info/top_level.txt
+tests/test_diff.py
+tests/test_prompt.py

gitme_ai-0.1.0/gitme_ai.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

gitme_ai-0.1.0/gitme_ai.egg-info/requires.txt

@@ -0,0 +1,5 @@
+click>=8.0
+rich>=13.0
+pyperclip>=1.8
+requests>=2.28
+tomli-w>=1.0

gitme_ai-0.1.0/gitme_ai.egg-info/top_level.txt

@@ -0,0 +1 @@
+gitme

gitme_ai-0.1.0/pyproject.toml

@@ -0,0 +1,33 @@
+[project]
+name = "gitme-ai"
+version = "0.1.0"
+description = "AI-powered git commit message generator"
+readme = "README.md"
+requires-python = ">=3.11"
+license = { text = "MIT" }
+authors = [
+    { name = "Rohit Balaji", email = "rohitvb26@gmail.com" }
+]
+keywords = ["git", "cli", "ai", "commit", "llm", "developer-tools"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Environment :: Console",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Version Control :: Git",
+]
+dependencies = [
+    "click>=8.0",
+    "rich>=13.0",
+    "pyperclip>=1.8",
+    "requests>=2.28",
+    "tomli-w>=1.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/RohitB2005/gitme-cli"
+Repository = "https://github.com/RohitB2005/gitme-cli"
+"Bug Tracker" = "https://github.com/RohitB2005/gitme-cli/issues"

gitme_ai-0.1.0/setup.cfg

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

gitme_ai-0.1.0/tests/test_diff.py

@@ -0,0 +1,33 @@
+import pytest
+from unittest.mock import patch, MagicMock
+from gitme.diff import get_staged_diff
+
+
+def test_raises_outside_git_repo():
+    mock = MagicMock()
+    mock.returncode = 1
+    with patch("subprocess.run", return_value=mock):
+        with pytest.raises(EnvironmentError, match="git repository"):
+            get_staged_diff()
+
+
+def test_raises_when_nothing_staged():
+    def fake_run(cmd, **kwargs):
+        m = MagicMock()
+        m.returncode = 0
+        m.stdout = ""
+        return m
+    with patch("subprocess.run", side_effect=fake_run):
+        with pytest.raises(ValueError, match="No staged changes"):
+            get_staged_diff()
+
+
+def test_returns_diff_string():
+    def fake_run(cmd, **kwargs):
+        m = MagicMock()
+        m.returncode = 0
+        m.stdout = "diff --git a/foo.py b/foo.py\n+hello"
+        return m
+    with patch("subprocess.run", side_effect=fake_run):
+        result = get_staged_diff()
+        assert "diff" in result

gitme_ai-0.1.0/tests/test_prompt.py

@@ -0,0 +1,16 @@
+from gitme.prompt import build_prompt, SYSTEM_PROMPT
+
+
+def test_build_prompt_contains_diff():
+    diff = "diff --git a/foo.py b/foo.py\n+hello"
+    result = build_prompt(diff)
+    assert diff in result
+
+
+def test_system_prompt_mentions_conventional_commits():
+    assert "Conventional Commits" in SYSTEM_PROMPT
+
+
+def test_system_prompt_lists_types():
+    for t in ["feat", "fix", "refactor", "docs", "style", "test", "chore"]:
+        assert t in SYSTEM_PROMPT