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.2.tar.gz
(2.4 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.2.tar.gz.
File metadata
- Download URL: ai_readme-0.1.2.tar.gz
- Upload date:
- Size: 2.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.9.21
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
57cb73ab868ac72f8ac110ad72f983b7e3861a7bf95c18f8b821211bc513c871
|
|
| MD5 |
93aada2142b064ca8b76129ec46eb3a5
|
|
| BLAKE2b-256 |
0d730e227106724961a70ac4e2224b252ab91226813ae2749faeee3fd022aeea
|
File details
Details for the file ai_readme-0.1.2-py3-none-any.whl.
File metadata
- Download URL: ai_readme-0.1.2-py3-none-any.whl
- Upload date:
- Size: 2.7 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 |
6ec7b6f50dce8ae3924533c40cd407ae27877a704441c5f149940ba6dfa7ae79
|
|
| MD5 |
feac790fb5cce82f6b39fc561453790d
|
|
| BLAKE2b-256 |
ef36054c5a2053eff9a7cb53e35e17d65bd4eae75e62a53f7ac950a10aa50eff
|
