🤖 readmeai
AI-powered README generator for any project.
readmeai analyzes your project directory and generates a professional README.md using AI. No more staring at a blank page – just run readmeai and get a complete, well-structured README in seconds.
✨ Features
- 🔍 Scans project structure and key configuration files
- 🧠 Uses AI to write a comprehensive README tailored to your project
- 📦 Supports Python, Node.js, Rust, Go, and more
- 🎨 Includes badges, install instructions, usage examples, and contributing guide
- ✍️ Interactive mode: preview before saving
- 🔌 Pluggable AI providers: OpenCode, OpenAI, Ollama
- 🐍 Zero heavy dependencies – only
requests
🚀 Quickstart
1. Install
pip install readmeai-py
2. Configure your AI provider (default: OpenCode)
export OPENCODE_API_URL="http://localhost:8080/v1/chat/completions"
export OPENCODE_API_KEY="your-key-here"
For OpenAI:
export OPENAI_API_KEY="sk-..."
For Ollama:
export OLLAMA_API_URL="http://localhost:11434/api/generate"
3. Generate a README
cd your-project
readmeai
Or specify a directory and use interactive mode:
readmeai /path/to/project --interactive
📦 Usage
readmeai [directory] [options]
| Option | Description |
|---|---|
directory |
Project directory (default: current) |
-o, --output |
Output file path (default: README.md in project root) |
-i, --interactive |
Preview and confirm before writing |
--provider |
AI provider: opencode (default), openai, ollama |
--model |
Model name |
--api-url |
Override API base URL |
--api-key |
Override API key |
--version |
Show version |
🔧 Supported AI Providers
| Provider | Default Model | Env Vars |
|---|---|---|
| OpenCode | opencode |
OPENCODE_API_URL, OPENCODE_API_KEY |
| OpenAI | gpt-4o-mini |
OPENAI_API_KEY |
| Ollama | llama3 |
OLLAMA_API_URL |
🤖 How It Works
- Recursively scans the project directory (ignoring common junk folders)
- Collects the file tree and reads important files (e.g.,
pyproject.toml,package.json) - Constructs a summary and sends it to the AI with a specialized prompt
- The AI returns the full README content, which is written to disk
- Optionally shows a preview for approval
🛠 Development
Clone and install in editable mode:
git clone https://github.com/erico964-blip/readmeai
cd readmeai
pip install -e .
📜 License
MIT © erico964-blip
Metadata
Release files for readmeai-py 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| readmeai_py-0.1.0.tar.gz | 9.5 kB | Without provenance | Details for readmeai_py-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| readmeai_py-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for readmeai_py-0.1.0-py3-none-any.whl |
Total release size: 19.1 kB
Release files / readmeai_py-0.1.0.tar.gz
| Download URL | readmeai_py-0.1.0.tar.gz |
|---|---|
| Size | 9.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
627fb9c71fcce74b83dcf9fcd742b3c74e55c9a21088e019409a95a50cd4c8a6
|
|
BLAKE2b-256 checksum How to use checksums |
aa8a478e63efc1ad7fe828f1ad27e3c6fcb4cb8cb46982266a92d285296ecc2b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.9
|
Release files / readmeai_py-0.1.0-py3-none-any.whl
| Download URL | readmeai_py-0.1.0-py3-none-any.whl |
|---|---|
| Size | 9.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e81baa1cf57bc852b802a46ff0fe8f7b1a9b000675d6893b5af4528aa9dec2ac
|
|
BLAKE2b-256 checksum How to use checksums |
0fe71c518d5cc173a3e708ad05a2c3fb87a1928ddfa4aa617826a5420808d0bc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.9
|
Security for readmeai-py 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.