Automatically generate README.md using AI.
Project description
Readme Generator
Generate a professional README.md automatically by analyzing project files using AI.
Features
- Support for English and Korean README generation.
- Selectable AI providers: OpenAI, Claude, Gemini.
- Configurable maximum characters to read per file.
- Automatically ignores unnecessary folders (e.g.,
.git/,node_modules/,venv/,__pycache__). - Easy
.env-based API key management.
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 5000
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 Distributions
No source distribution files available for this release.See tutorial on generating distribution archives.
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.0-py3-none-any.whl.
File metadata
- Download URL: ai_readme-0.1.0-py3-none-any.whl
- Upload date:
- Size: 1.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 |
e5d9e4571bdf56e5f44f941870a1b2644ecf93b632f9dec35608d65f16c63ecd
|
|
| MD5 |
91fd330a3ecaf973bac6dadbf5ff7d88
|
|
| BLAKE2b-256 |
b44ed0ce779aa9510865ba979a49f35eb16bad7d7426802f6d193d0a96cf3445
|
