Metadata-Version: 2.4
Name: git-ai-summary
Version: 0.1.0
Summary: CLI tool to generate README, CHANGELOG, and PR descriptions using Groq AI
Project-URL: Homepage, https://github.com/wquintili88/git-ai-summary
Project-URL: Repository, https://github.com/wquintili88/git-ai-summary
Project-URL: Issues, https://github.com/wquintili88/git-ai-summary/issues
License: MIT
Keywords: ai,changelog,cli,git,groq,llama,readme
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.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Version Control :: Git
Requires-Python: >=3.9
Requires-Dist: gitpython>=3.1.40
Requires-Dist: groq>=0.9.0
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: rich>=13.0.0
Requires-Dist: typer>=0.12.0
Description-Content-Type: text/markdown

# git-ai-summary

> CLI tool that auto-generates README, CHANGELOG, and PR descriptions from your git history using Groq AI (Llama 3.3 70B).

## Features

- `git-ai readme` — scans your repo and generates a professional README.md
- `git-ai changelog --since <tag>` — generates a Keep-a-Changelog section from commits
- `git-ai pr-desc` — generates a GitHub PR description from staged changes
- Rich Markdown preview in terminal (`--preview`)
- Pipe-friendly: raw Markdown goes to stdout by default

## Requirements

- Python 3.9+
- A [Groq API key](https://console.groq.com/keys) (free tier available)

## Installation

```bash
pip install git-ai-summary
```

Or from source:

```bash
git clone https://github.com/wquintili88/git-ai-summary
cd git-ai-summary
pip install -e .
```

## Configuration

```bash
cp .env.example .env
# Open .env and set your GROQ_API_KEY
```

Or export directly in your shell:

```bash
export GROQ_API_KEY=gsk_...
```

## Usage

```bash
# Generate README (print to stdout)
git-ai readme

# Save directly to file
git-ai readme -o README.md

# Render Markdown preview in terminal
git-ai readme --preview

# Generate CHANGELOG since a tag
git-ai changelog --since v1.0.0
git-ai changelog --since v1.0.0 --version-label v1.1.0 -o CHANGELOG.md

# Generate PR description from staged changes
git add .
git-ai pr-desc
git-ai pr-desc --preview
```

## Options

| Command | Flag | Description |
|---|---|---|
| all | `--repo PATH` | Path to git repo (default: `.`) |
| all | `--output / -o PATH` | Write output to file |
| all | `--preview / -p` | Render Markdown in terminal |
| `changelog` | `--since / -s REF` | Tag or SHA to compare from (required) |
| `changelog` | `--version-label` | Release label (e.g. `v1.2.0`) |

## Security

- Never commit your `.env` file — it is listed in `.gitignore`
- The `.env.example` file contains only placeholder values and is safe to commit

## Contributing

Pull requests are welcome. For major changes, open an issue first to discuss what you'd like to change.

## License

MIT
