Automatically generate README.md using AI.
Project description
AI Readme
Generate a professional README.md automatically by analyzing project files using AI.
Features
- English and Korean README generation.
- Support OpenAI, Claude, Gemini models.
- Detailed, professional README templates.
- Smart file ignoring (.git, node_modules, etc.).
- Easy .env based API key configuration.
Installation
pip install ai-readme
Usage
readme --lang en --provider openai
readme --lang ko --provider claude
readme --lang en --provider gemini
readme --lang en --provider openai --max_chars 20000
Setting up API Keys
You must configure your API keys before using this tool.
There are two ways:
1. Using a .env file (Recommended)
Create a .env file in your project root and add:
OPENAI_API_KEY=your-openai-api-key
CLAUDE_API_KEY=your-claude-api-key
GEMINI_API_KEY=your-gemini-api-key
The program automatically loads this file.
2. Setting environment variables manually
If you prefer, you can set them manually in your terminal session:
Linux / macOS:
export OPENAI_API_KEY=your-openai-api-key
Windows CMD:
set OPENAI_API_KEY=your-openai-api-key
Windows PowerShell:
$env:OPENAI_API_KEY="your-openai-api-key"
License
MIT License
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file ai_readme-0.1.6.tar.gz.
File metadata
- Download URL: ai_readme-0.1.6.tar.gz
- Upload date:
- Size: 6.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.9.21
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
de0ef7d3796db0cf38655e4085fad6d582f5a4ac2d865b7aa7fed8acd5c85ceb
|
|
| MD5 |
f3542a0b5a1d8b8cbaca9e4ef0697ce5
|
|
| BLAKE2b-256 |
c516eeff58e55d7eff9a0cb3380139bdb67ec0295f4a91d478d1dd4ce3daefd1
|
File details
Details for the file ai_readme-0.1.6-py3-none-any.whl.
File metadata
- Download URL: ai_readme-0.1.6-py3-none-any.whl
- Upload date:
- Size: 8.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.9.21
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f2a7ab4ac703d2497debcfd061ef846b0b2b8032e6a27894e0484ed62ee86cfe
|
|
| MD5 |
20473487ec1770fcfdc13a0bc1c1c0e1
|
|
| BLAKE2b-256 |
a02a6d4af65689a75c4333290e17b06fad618a9961916f293aa2d5bab67c0c71
|
