gitready

gitready

Universal Package Creator and Portfolio Polisher v5.15.2

Create GitHub-ready Python libraries, Claude skills, and Claude Code plugins with badges, CI/CD workflows, coverage metrics, media artifacts, and automated GitHub publication.

Quick Start

# Create a new package (auto-detects type)
/gitready mylib

# Polish existing repository
/gitready --target P:/packages/existing-repo

# Preview what will happen
/gitready --dry-run myproject

See The Transformation

gitready transforms a rough project into a polished GitHub-ready package:

Aspect	Before	After
Documentation	Missing or minimal README	Full README with badges, install guide, usage
CI/CD	No workflows	GitHub Actions with pytest, coverage, linting
Versioning	Manual	Automated CHANGELOG generation
Badges	None	Version, License, Tests, Coverage badges
Media	None	Architecture diagram, explainer video, slides
Publication	Local only	Automated GitHub repo creation and release

Before:

my-package/
  my_module.py
  README.md (minimal)

After:

my-package/
  my_module.py
  README.md (polished with badges + media)
  CHANGELOG.md (auto-generated)
  CONTRIBUTING.md
  LICENSE
  .github/
    workflows/
      ci.yml
      release.yml
  assets/
    videos/
    slides/
    banners/
  docs/
    video.html (GitHub Pages player)

Explainer Video

🎬 Watch the explainer in the browser ⬇️ Download the MP4 directly Browser playback requires GitHub Pages to be enabled for this repository.

Quick overview: Features, workflow, and automated portfolio polish. Runtime should match the exported NotebookLM asset; update this text only after verifying the final file duration.

What gitready Does

• 🎯 Intelligent Detection: Automatically detects package type and requirements from project structure
• 📦 Multi-Format Support: Creates Claude skills, Python libraries, and Claude Code plugins
• 🎨 Portfolio Polish: Adds badges, CI/CD, CHANGELOG, API docs, and media artifacts
• 🎬 Media Generation: Creates banners, diagrams, explainer videos, and presentations
• 🔍 Code Review: Automated quality validation before portfolio polish
• 🔄 Brownfield Conversion: Converts existing Python libraries to plugins
• 🚀 GitHub Publication: Automated monorepo extraction and repository creation

One command → Full intelligent pipeline:

1. DETECT — Scan repository, identify gaps and needs
2. ANALYZE — Determine package type automatically
3. GENERATE — Create all missing artifacts (structure, badges, CI/CD, docs, CHANGELOG)
4. VALIDATE — Verify everything works
5. CLEANUP — Detect and remove obsolete files from refactoring
6. PUBLISH — Extract from monorepo, create GitHub repository, push code
7. REPORT — Show what was created with evidence

What Gets Created

gitready generates this complete package structure:

{{package-name}}/
├── README.md                    # Polished with badges, media, install guide
├── CHANGELOG.md                # Auto-generated from git commits
├── CONTRIBUTING.md             # Contribution guidelines
├── LICENSE                     # MIT License
├── .github/
│   └── workflows/
│       ├── ci.yml             # Tests, lint, coverage
│       └── release.yml         # Auto-release on tag
├── assets/
│   ├── videos/
│   │   └── {{package-name}}_explainer_pbs.mp4
│   ├── slides/
│   │   └── {{package-name}}_slides.pdf
│   └── banners/
│       └── {{package-name}}_banner.png
├── docs/
│   └── video.html              # GitHub Pages video player
├── skills/                     # (if Claude Skill type)
│   └── {{skill-name}}/
│       └── SKILL.md
├── core/                       # (if Plugin type)
│   └── hooks/
│       └── *.py
└── scripts/
    └── *.py                    # Helper scripts

Which Package Type Do You Need?