projectreadmegen 1.7.1

Auto-generate README files from folder structure

PROJECT README GEN

Auto-generate README files from folder structure with optional AI enhancement using Groq API.

Installation

pip install projectreadmegen

OR

PyPi - (https://pypi.org/project/projectreadmegen)

Quick Start

# Run directly with Python
python -m projectreadmegen generate .

# Or add to PATH for convenience
set PATH=%PATH%;%APPDATA%\Python\Python314\Scripts

# Then use simple command
projectreadmegen generate .

Usage

Generate README (Quick Mode)

# Basic - template-based
python -m projectreadmegen generate .

# With AI enhancement
python -m projectreadmegen generate . --ai
python -m projectreadmegen generate . -a

# Auto-detect AI when API key available
python -m projectreadmegen generate . --auto-ai

Interactive Mode

# Start menu
python -m projectreadmegen

# Or CLI-based interactive
python -m projectreadmegen interactive .
python -m projectreadmegen interactive . --ai

Options

Flag	Short	Description
--template	-t	Template: minimal, standard, full, academic
--output	-o	Output filename (default: README.md)
--depth	-d	Tree depth (default: 3)
--ai	-a, --grok	Use Groq AI for enhanced README
--auto-ai		Auto-use AI when API key available
--force	-f	Overwrite without confirmation
--dry-run		Preview without saving
--no-badges		Disable badge generation
--version	-V	Show version

Commands

Command	Description
generate	Generate README from folder
interactive	Interactive Q&A mode
start	Start interactive menu
update	Check and install updates
version	Show version info

Menu Mode

Run python -m projectreadmegen for interactive menu:

1  Create README with AI
2  Create Normal README (template-based)
3  Manage API Key
4  View Credits Status
5  Update projectreadmegen
6  Help & Commands
7  Exit

Configuration

Create readmegen.config.json in project root:

{
    "template": "standard",
    "ai_enabled": true,
    "groq_api_key": "your_key_here",
    "include_badges": true,
    "include_tree": true,
    "max_tree_depth": 3,
    "output_file": "README.md"
}

API Key

Get free Groq API key: https://console.groq.com/keys

# Set environment variable
export GROQ_API_KEY=your_key_here

# Windows
$env:GROQ_API_KEY="your_key_here"

Features

• Auto-detect - Project type and tech stack detection
• Folder Tree - ASCII tree visualization
• AI Generation - Groq-powered enhanced README
• 4 Templates - minimal, standard, full, academic
• Badges - Auto language and license badges
• Smart Caching - Faster repeated scans
• Template Memory - Remembers last template per project
• Update Detection - Warns if README modified externally
• Credit System - 5 free AI uses/day (then use your own key)

Credits

• 5 free AI uses per day
• Add your own Groq API key for unlimited use
• Groq API Generator

---

© 2026 Zenith Open Source Projects. All Rights Reserved. Zenith is a Open Source Project Idea's by @roshhellwett