Overview
Developer documentation for the wyattowalsh GitHub profile README generator.
This repo auto-generates a fully dynamic GitHub profile README.md — SVG banners, generative art, word clouds, QR codes, GitHub metrics, skills badges, and more — via a Python CLI that runs daily on GitHub Actions.
What lives here
| Layer | What it does |
|---|---|
CLI (scripts/cli/) | Typer-based entry point for every generation and dev command |
Config (scripts/config.py) | Pydantic models that drive all settings via config.yaml |
Banner (scripts/banner.py) | Procedural SVG banner with chaos-attractor backgrounds |
QR Code (scripts/qr.py) | Styled QR codes with embedded SVG backgrounds |
Word Clouds (scripts/word_clouds.py) | OKLCH-palettized word clouds from starred-repo data |
Technologies (scripts/techs.py) | Parses techs.md into shields.io badge rows |
Skills (scripts/skills.py) | Renders skills.yaml into shields.io badge sections |
Generative Art (scripts/generative.py) | Lorenz/neural/flow-field SVG art seeded from GitHub metrics |
Animated Art (scripts/animated_art.py) | CSS-animated SVGs seeded from commit history; compatibility shim over scripts/art/* generators |
Ink Garden (scripts/art/ink_garden.py) | Procedural garden that grows with your activity |
Topography (scripts/art/topography.py) | Topographic contour art with hillshade and rivers |
Metrics (scripts/fetch_metrics.py) | GitHub GraphQL API → structured metrics JSON |
History (scripts/fetch_history.py) | Paginated commit history → time-series JSON |
README Sections (scripts/readme_sections.py) | Assembles final README from all generated fragments |
README SVG (scripts/readme_svg.py) | Reusable SVG rendering helpers for README cards and blocks |
Quick navigation
Getting Started
Clone, install, and run your first generation
CLI Reference
All commands, flags, and subcommands
Script Modules
Per-module deep dives for every generator
GitHub Actions
The daily CI pipeline and job graph
Architecture
Directory layout, module dependencies, and design decisions
Testing
pytest, golden-file regression, and property-based testing