ReadmeCraft
An automated README.md generator that creates professional documentation for your projects with AI assistance.
·
·
About The Project
ReadmeCraft is a Python-based tool that automatically generates comprehensive README.md files for software projects. It analyzes project structure, dependencies, and scripts to create professional documentation with minimal user input. The tool leverages AI to generate descriptions, create project logos, and format content according to best practices.
Key features:
- Automatic project structure analysis
- AI-powered script descriptions
- Dependency detection
- Logo generation
- Git integration
- Customizable templates
Built With
- Python
- cairosvg (for SVG to PNG conversion)
- Rich (for console formatting)
- OpenAI API (for AI-powered content generation)
Getting Started
Prerequisites
- Python 3.7+
- OpenAI API key (for AI features)
- cairosvg dependencies (libcairo2 on Linux)
Installation
- Clone the repository:
git clone https://github.com/your_username/readmecraft.git
- Install dependencies:
pip install -e .
- Set up your OpenAI API key:
export OPENAI_API_KEY='your-api-key'
Usage
Run the tool from the command line:
python -m readmecraft.utils.cli /path/to/your/project
The tool will:
- Analyze your project structure
- Generate a logo
- Create a comprehensive README.md file
Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature) - Commit your Changes (
git commit -m 'Add some AmazingFeature') - Push to the Branch (
git push origin feature/AmazingFeature) - Open a Pull Request
License
Distributed under the MIT License. See LICENSE.txt for more information.
Contact
Your Name - @your_twitter - your.email@example.com
Project Link: https://github.com/your_username/readmecraft
Acknowledgments
1 maintainer
Metadata
1 maintainer
Release files for readmecraft 0.1.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| readmecraft-0.1.8.tar.gz | 11.6 kB | Without provenance | Details for readmecraft-0.1.8.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| readmecraft-0.1.8-py3-none-any.whl | Python 3 | none | any | Details for readmecraft-0.1.8-py3-none-any.whl |
Total release size: 23.9 kB
Release files / readmecraft-0.1.8.tar.gz
| Download URL | readmecraft-0.1.8.tar.gz |
|---|---|
| Size | 11.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6a8ebbb8d03aebb2ce848b576563b05bd7c2d2d50fdacf5f1715c2f183268b5e
|
|
BLAKE2b-256 checksum How to use checksums |
fefecb1d2313db5ffa29b205dc5399eb67c739fbd6a4a0fc4999c5a8ee92ae3f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.22
|
Release files / readmecraft-0.1.8-py3-none-any.whl
| Download URL | readmecraft-0.1.8-py3-none-any.whl |
|---|---|
| Size | 12.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0d36f17197c350e3f17fdcdd615fd142559889d918a481033fb7e9162312167f
|
|
BLAKE2b-256 checksum How to use checksums |
a9f2edc50a5759288889adfbe7d2f7b989a8d5610bb28a49c0bb2d64e4586683
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.9.22
|
Security for readmecraft 0.1.8
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
