readmecraft 0.1.6

A tool to automatically generate README files for your projects.

ReadmeCraft

An AI-powered tool for automatically generating professional README.md files for your projects.
· ·

---

About The Project

ReadmeCraft is a Python-based tool that automates the creation of comprehensive README.md files for software projects. It analyzes your project structure, dependencies, and scripts to generate polished documentation with minimal effort. Key features include:

• Project Analysis: Scans your project directory to understand its structure and components
• AI-Powered Descriptions: Uses LLMs to generate meaningful descriptions for your scripts
• Dynamic README Generation: Populates a professional template with project-specific details
• Logo Generation: Creates minimalist SVG logos for your project documentation

Built With

• Python
• OpenAI API (for LLM integration)
• Rich (for console output formatting)
• Pytest (for testing)

Getting Started

Prerequisites

• Python 3.8+
• OpenAI API key (for full functionality)
• Git (for repository information extraction)

Installation

1. Clone the repository

   git clone https://github.com/your_username/readmecraft.git
   

2. Install dependencies

   pip install -e .
   

3. Configure your OpenAI API key

   export OPENAI_API_KEY='your-api-key'
   

Usage

Run the following command in your project directory:

python -m readmecraft.utils.cli /path/to/your/project

The tool will:

1. Analyze your project structure
2. Generate script descriptions
3. Create a professional README.md file
4. Optionally generate a project logo

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.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Your Name - @your_twitter - [e-mail]

Project Link: https://github.com/your_username/readmecraft

Acknowledgments

• OpenAI
• Rich
• Python

(back to top)