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.3.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.3.tar.gz.
File metadata
- Download URL: ai_readme-0.1.3.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 |
62103d5e4b1529b08c27ab135d9c04144892277af0d94109cf6333a6ef04a1bc
|
|
| MD5 |
03297957e001c80e4695c4e30e92c65f
|
|
| BLAKE2b-256 |
ab745923922491de5c54d60539aebde0ec2bd609a0ee4efcd6bf2b677ebad4ae
|
File details
Details for the file ai_readme-0.1.3-py3-none-any.whl.
File metadata
- Download URL: ai_readme-0.1.3-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 |
f20acf61226562ed3ae6e2bc655ec31e172f6f6a29b083d36375f642f1946ab5
|
|
| MD5 |
9e4143288bf816c8672184d04a93b45f
|
|
| BLAKE2b-256 |
e422ad26cdd122858ad1d3b410ae13bfa163c0e53c76357d226d6434c1a582bd
|
