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
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
ai_readme-0.1.1.tar.gz
(5.0 kB
view details)
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.1.tar.gz.
File metadata
- Download URL: ai_readme-0.1.1.tar.gz
- Upload date:
- Size: 5.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.9.21
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
56870e357ba18c02618424cd3bf3a452b182c9c9b7471bbb1505d0afc6e2d88e
|
|
| MD5 |
05c14574c9a34aac3a37fddbdf76f194
|
|
| BLAKE2b-256 |
afe34fe43f8402bd1c64e4b4d66b146d5f76c30e89e389996a06229c951337e9
|
File details
Details for the file ai_readme-0.1.1-py3-none-any.whl.
File metadata
- Download URL: ai_readme-0.1.1-py3-none-any.whl
- Upload date:
- Size: 7.3 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 |
fab81da05aacdfd226d1963a906e628074a3ee1985dd7be4898be216fda46c0c
|
|
| MD5 |
4e9ad0fdc2bec9637b85c53aed97a145
|
|
| BLAKE2b-256 |
a496bfd302414b4c17c07ffea9b7a6498b6348b8ad92859fcb65bd1f715c8084
|
