Metadata-Version: 2.4
Name: gitmeup
Version: 1.0.0
Summary: LLM-assisted conventional commits generator for git repositories. Automatically generates git add and commit lines based on git diff and status.
License: MIT License
        
        Copyright (c) 2025 @ikramagix
        
        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 NON-INFRINGEMENT. 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.
        
Project-URL: Homepage, https://github.com/ikramagix/gitmeup
Project-URL: Source, https://github.com/ikramagix/gitmeup
Project-URL: Issues, https://github.com/ikramagix/gitmeup/issues
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: google-genai>=0.6.0
Requires-Dist: python-dotenv>=1.0.0
Dynamic: license-file

# gitmeup

`gitmeup` is a lightweight command-line tool that automates Conventional Commit generation using an LLM.
It analyses your working tree using `git diff --stat`, `git status`, and a filtered `git diff`, then produces
atomically grouped `git add` and `git commit` commands with strict path-quoting rules.

This improves commit hygiene in large or fast-moving repositories while reducing cognitive overhead.

## Features

- Extracts:
  - `git diff --stat`
  - `git status --short`
  - `git diff` excluding image and binary noise
- Sends structured context to an LLM
- Produces:
  - Precise Conventional Commits
  - Batched `git add` / `git commit` sequences
  - Proper double-quote path escaping
- Dry-run or apply mode
- Minimal overhead, only Python and git required

## Installation

### Local development (editable)

```bash
git clone https://github.com/ikramagix/gitmeup
cd gitmeup

python3 -m venv .venv
source .venv/bin/activate

pip install --upgrade pip
pip install -e .
```

### System-wide (user environment)

```bash
pip install git+https://github.com/ikramagix/gitmeup
```

Ensure `GEMINI_API_KEY` is configured:

```bash
export GEMINI_API_KEY="your-key"
```

You also need a model with:

```bash
export GITMEUP_MODEL="a gemini model"
```

## Usage

From any git repository with uncommitted changes:

```bash
gitmeup
```

Dry-run prints proposed commands. To apply staged operations:

```bash
gitmeup --apply
```

Specify a model:

```bash
gitmeup --model gpt-4.1
```

Specify an API key manually:

```bash
gitmeup --api-key sk-....
```

## Example

```bash
gitmeup
```

Sample output:

```bash
git add src/app/main.py
git add src/app/utils/helpers.py
git commit -m "refactor(core): clean helper logic"
```

## License

MIT License. See `LICENSE` for details.

## Maintainer

Created and maintained by **@ikramagix**.
