Metadata-Version: 2.4
Name: surgite
Version: 1.8.0
Summary: Git commit history summarizer with AI.
Keywords: standup,git,summary,changelog,ai,llm,fastapi
Author: Nick Coleman
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Version Control :: Git
Classifier: Topic :: Text Processing :: General
Classifier: Typing :: Typed
Requires-Dist: python-dotenv>=1.2.2
Requires-Dist: sqlalchemy>=2.0.49
Requires-Dist: alembic>=1.18.4
Requires-Dist: psycopg2-binary>=2.9.12
Requires-Dist: fastapi>=0.136.1
Requires-Dist: uvicorn>=0.47.0
Requires-Dist: httpx>=0.27.0
Requires-Dist: argon2-cffi>=23.1.0
Requires-Dist: cryptography>=46.0.0
Requires-Dist: keyring>=25.7.0
Requires-Python: >=3.14
Project-URL: Homepage, https://github.com/nicoleman0/surgite
Project-URL: Source, https://github.com/nicoleman0/surgite
Project-URL: Documentation, https://github.com/nicoleman0/surgite#readme
Project-URL: Changelog, https://github.com/nicoleman0/surgite/blob/main/CHANGELOG.md
Project-URL: Issues, https://github.com/nicoleman0/surgite/issues
Description-Content-Type: text/markdown

# surgite

Standup summaries from Git history, in a browser or terminal.

[![CI](https://github.com/nicoleman0/surgite/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/nicoleman0/surgite/actions/workflows/ci.yml)
[![PyPI](https://img.shields.io/pypi/v/surgite)](https://pypi.org/project/surgite/)
[![Python versions](https://img.shields.io/pypi/pyversions/surgite)](https://pypi.org/project/surgite/)
[![Container image](https://img.shields.io/badge/ghcr.io-surgite-blue?logo=docker&logoColor=white)](https://github.com/nicoleman0/surgite/pkgs/container/surgite)
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)

![surgite dashboard](https://raw.githubusercontent.com/nicoleman0/surgite/main/docs/demo.gif)

## Quickstart

**Local CLI** — no server or database:

```bash
pip install surgite
surgite /path/to/repo --since 7.days.ago
```

Add `--summarize` for an AI summary after configuring a provider key.

**Web app** — clone the repository and start Compose:

```bash
git clone https://github.com/nicoleman0/surgite.git
cd surgite
cp .env.example .env
# For multi-user access, set AUTH_MODE=multi_user and BOOTSTRAP_OWNER_EMAIL.
docker compose up -d
```

In multi-user mode, first start logs an owner invite. Redeem it in the browser
or with `surgite --redeem-invite <token> --email you@example.com`. The full
deployment guide is [docs/self-host.md](docs/self-host.md).

## Features

- Per-user repositories, prompt settings, summaries, and shared links
- Local CLI or a self-hosted FastAPI/Postgres/SvelteKit application
- Anthropic, Groq, DeepSeek, or OpenAI-compatible local models
- Email/password auth, API keys, encrypted per-user provider keys, Git connections, and audit logs

## Private repositories

Add an HTTPS Git connection in **Settings** with a credential-free origin, username, and
read-only access token. Surgite encrypts it at rest and only supplies it to Git through a
non-interactive askpass helper. Never paste credentials into a repository URL.

## Documentation

- [Self-hosting](docs/self-host.md)
- [Security model](docs/security.md) and [security policy](SECURITY.md)
- [API stability policy](docs/api-stability.md) and [OpenAPI contract](docs/openapi.json)
- [Contributing](CONTRIBUTING.md), [release history](CHANGELOG.md), and [upgrade guides](docs/migrations)

## Development

```bash
uv sync --group dev
docker compose up -d db
uv run alembic upgrade head
uv run pytest
cd frontend && npm install && npm run check && npm run test
```

See [CONTRIBUTING.md](CONTRIBUTING.md) for the full workflow and
[AGENTS.md](AGENTS.md) for architecture and project conventions.

## License

[MIT](LICENSE) © 2026 Nick Coleman
