lmig-generate-readme 0.1.3

A tool to automate readme generation

LMIG Generate README

Description

LMIG Generate README is a tool designed to automate the creation of comprehensive README files for projects. It analyzes the project's structure and content, using Liberty GPT AI to generate a professional README file, enhancing documentation and improving project understanding.

Key Features

• Automatically clones the specified GitHub repository.
• Extracts project tree structure and relevant file contents.
• Communicates with Liberty GPT AI to generate a detailed README file.
• Writes the generated README back into the repository.
• Supports a wide range of file types for content extraction.
• Handles potential file size and depth limitations with fallback mechanisms.

Technology Stack

• Python: Main programming language.
• Liberty GPT AI: For intelligent README generation.
• Bash: For environment control and scripting.
• Python Libraries:
  • requests: For API calls.
  • python-decouple: For managing environment variables.
  • setuptools, wheel: For packaging.

Installation

Prerequisites

• Python version >= 3.6
• Git installed on your machine.
• Bash shell, especially if you're on Windows, use something like Git Bash.
• Access token for Liberty GPT AI.

Setup

1. Clone this repository:

   git clone https://github.com/lmigtech/generate-readme.git
   cd generate-readme
   

2. Create a .env file in the root directory and add your API token:

   USER_ACCESS_TOKEN='YOUR_ACCESS_TOKEN'
   

3. Install required Python packages using pip:

   pip install -r requirements.txt
   

4. Ensure environment variables are loaded; for bash:

   source .env
   

Usage

Run the main script to generate a README:

python -m generate_readme.main

You can customize the output directory for analysis files or decide whether to back up existing README files through command prompts.

Project Structure

lmig_generate_readme/
├── bin
│   └── runMain
├── generate_readme
│   ├── __init__.py
│   ├── main.py
│   └── request.py
├── lmig_generate_readme.egg-info
│   ├── dependency_links.txt
│   ├── entry_points.txt
│   ├── PKG-INFO
│   ├── SOURCES.txt
│   └── top_level.txt
├── .gitignore
├── git_push.sh
├── LICENSE
├── MANIFEST.in
├── pyproject.toml
├── README.md
├── README.md.backup
├── requirements.txt
└── setup.py

Configuration

Ensure the .env file is correctly configured with the USER_ACCESS_TOKEN. Adjustments to the code may be necessary if your development environment requires further customization.

Contributing

Contributions are welcome! For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

By utilizing this repository, you agree to adhere to our guidelines and licensing agreements.