Metadata-Version: 2.4
Name: aaxnet-readme-ai
Version: 0.1.0
Summary: Generate beautiful README files from your code using AI
Author: readme-ai contributors
License-Expression: MIT
Project-URL: Homepage, https://github.com/aaxnet/readme-ai
Project-URL: Repository, https://github.com/aaxnet/readme-ai
Project-URL: Issues, https://github.com/aaxnet/readme-ai/issues
Keywords: readme,ai,documentation,cli,anthropic,claude
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
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 :: Documentation
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: anthropic>=0.25.0
Requires-Dist: click>=8.0.0
Requires-Dist: rich>=13.0.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0; extra == "dev"
Requires-Dist: ruff>=0.4.0; extra == "dev"
Requires-Dist: mypy>=1.8; extra == "dev"
Dynamic: license-file

<div align="center">

# 🤖 readme-ai

**Generate beautiful, production-ready README files from your code using AI.**

[![PyPI version](https://img.shields.io/pypi/v/readme-ai?color=blue&style=flat-square)](https://pypi.org/project/readme-ai/)
[![Python](https://img.shields.io/pypi/pyversions/readme-ai?style=flat-square)](https://pypi.org/project/readme-ai/)
[![CI](https://img.shields.io/github/actions/workflow/status/aaxnet/readme-ai/ci.yml?style=flat-square&label=CI)](https://github.com/aaxnet/readme-ai/actions)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](LICENSE)
[![Powered by Claude](https://img.shields.io/badge/Powered%20by-Claude%20AI-orange?style=flat-square)](https://anthropic.com)

Point it at any codebase. Get a README worth starring.

</div>

---

## ✨ Features

- **Understands your code** — scans source files, package manifests, and directory structure; builds context before writing a single word
- **Production-quality output** — badges, installation instructions, real usage examples, configuration docs, contributing guide
- **Smart prioritisation** — reads `pyproject.toml`, `package.json`, `main.py` and similar files first so the AI leads with the most important context
- **15+ languages supported** — Python, TypeScript, Go, Rust, Java, C/C++, Ruby, PHP, and more
- **Dry-run mode** — `readme-ai scan` shows exactly what the AI will see, with no API call
- **Multilingual output** — generate in English or Russian (`--language ru`)
- **Non-destructive** — always asks before overwriting an existing README

## 📦 Installation

```bash
pip install readme-ai
```

Or with [`pipx`](https://pipx.pypa.io/) for an isolated global install:

```bash
pipx install readme-ai
```

**Requirements:** Python 3.9+ · An [Anthropic API key](https://console.anthropic.com/)

## 🚀 Usage

### Generate a README

```bash
# Set your API key once
export ANTHROPIC_API_KEY="sk-ant-..."

# Generate README for the current directory
readme-ai generate .

# Or point at any project
readme-ai generate ~/projects/my-app

# Preview in terminal without writing to disk
readme-ai generate . --preview

# Generate in Russian
readme-ai generate . --language ru

# Write to a custom path
readme-ai generate . --output docs/README.md
```

### Inspect what the AI sees (no API call)

```bash
readme-ai scan .
```

Output:
```
Project: my-app
Files found: 12
Languages detected:
  Python          ████████████ 6
  TypeScript      ██████ 3
  Shell           ██ 1

Priority files:
  ★ pyproject.toml
  ★ main.py
  ★ requirements.txt
```

### Full options

```
readme-ai generate [OPTIONS] [PATH]

Arguments:
  PATH  Project directory [default: .]

Options:
  -o, --output PATH       Output file path [default: <path>/README.md]
  -k, --api-key TEXT      Anthropic API key (or set ANTHROPIC_API_KEY)
  -l, --language [en|ru]  Output language [default: en]
  -p, --preview           Print to stdout instead of writing to file
  -f, --overwrite         Skip the overwrite confirmation prompt
  -m, --model TEXT        Claude model to use
  -V, --version           Show version and exit
```

## ⚙️ Configuration

| Variable | Description | Required |
|---|---|---|
| `ANTHROPIC_API_KEY` | Your Anthropic API key | Yes |

Get your key at [console.anthropic.com](https://console.anthropic.com/).

The default model is `claude-sonnet-4-20250514`. You can override it with `--model`:

```bash
readme-ai generate . --model claude-opus-4-20250514
```

## 🔍 How it works

```
Your project
     │
     ▼
 📂 Scanner          Reads up to 30 files, prioritising entry points
     │               and package manifests. Builds a directory tree.
     ▼
 🧠 Prompt builder   Assembles structured context: tree, languages,
     │               package metadata, key source files.
     ▼
 ✨ Claude AI        Generates a README following strict documentation
     │               best practices with real examples and badges.
     ▼
 📄 README.md
```

## 🤝 Contributing

Contributions are welcome! Here's how to get started:

```bash
git clone https://github.com/aaxnet/readme-ai
cd readme-ai
pip install -e ".[dev]"
pytest tests/ -v
```

Please open an issue before starting work on a large feature. PRs should include tests.

## 📄 License

[MIT](LICENSE) © 2026 readme-ai contributors
