📄 README Generator

Analyse le code et génère un README.md surprenant

Génère automatiquement des README.md, RST ou Text à partir de l'analyse d'un projet.

✨ Features

• Analyse de code — détecte langages, frameworks, deps
• 3 formats — Markdown, RST, Text
• Sections auto — install, usage, features, contributors
• Style surprenant — emojis, citations, ASCII art
• Intégration git — détecte auteurs, commits, branches
• CLI complète — options pour personnaliser
• Tests — couverture complète

🚀 Installation

# Clone
git clone https://tea.notarock.lol/les_clankeurs/readme-generator.git
cd readme-generator

# Install
pip install -e .

# Dev
pip install -e ".[dev]"

📖 Utilisation

CLI

# Générer depuis un projet
readme-gen /chemin/vers/projet --format markdown

# Avec options
readme-gen . --format rst --style funny --langage visible

# Depuis git
readme-gen --git --format markdown

# Personnaliser
readme-gen . --style inspirational --title "Mon Super Projet"

API Python

from readme_gen import generate_readme

result = generate_readme(
    path="/chemin/vers/projet",
    format="markdown",
    style="funny",
)

print(result.content)

# Sauvegarder
result.save("README.md")

🎨 Styles disponibles

Style	Description
funny	Humour, emojis, ton décontracté
drame	Dramatique, poétique, intense
code-example	Exemples de code, technique
inspirational	Citations inspirantes, motivant

📊 Analyse

Le générateur détecte automatiquement:

• Langages — Python, JavaScript, Go, TypeScript, Rust...
• Frameworks — FastAPI, React, Django, Express...
• Dépendances — packages, libs, outils
• Structure — dossiers, fichiers clés, architecture
• Git — auteurs, commits, branches, contributions
• Licence — détecte automatiquement la licence
• Tests — coverage, frameworks de test

📦 Architecture

readme_gen/
├── cli.py              # Interface CLI
├── __init__.py         # Export principal
├── analyzers/
│   ├── code.py           # Analyse du code source
│   ├── git.py            # Analyse git (auteurs, commits)
│   └── deps.py           # Analyse des dépendances
├── generators/
│   ├── markdown.py       # Générateur Markdown
│   ├── rst.py            # Générateur RST
│   └── text.py           # Générateur Text
└── formatters/
    ├── style.py          # Styles (funny, drame...)
    └── ascii.py          # ASCII art décoratif

📝 Scripts

pytest                    # Tests
ruff check .             # Linting
ruff format .            # Formatage

🎯 Roadmap

• Support YAML/TOML frontmatter
• Détection automatique du template
• Plugin system pour analyseurs custom
• Export HTML/PDF
• Intégration CI/CD
• Support multi-langue (FR, EN, ES...)

📄 License

MIT — Ship it or meme it! 📄

---

Fait par Cloune pour les clankeurs ⚜️