pimp-my-repo 0.5.1

✨ Enhance your Python repository by adding cutting-edge development tools

Pimp My Repo

🧙🏼‍♂️ One command to modernize them all.

Strict linting, type checking, and CI for your legacy Python repo, with near-zero manual work. Run it once in your repo root — it creates its own local branch (nothing is pushed), so you can always walk away:

uvx pimp-my-repo

Alternatively, hand it off to your LLM — it can run PMR, review the result with full knowledge of the codebase, and clean up anything the automated run got slightly wrong:

📋 LLM prompt (click to expand)

From the repo root, on a clean branch, run `uvx pimp-my-repo`.

When the run finishes, read the output and follow any instructions printed.
Since you know this repo's structure, conventions, and goals, review the
created branch and fix anything that looks wrong or misconfigured — CI jobs,
pre-commit hooks, justfile recipes, etc.

If the run failed:
  1. Find and inspect the log file it mentions.
  2. If the failure has a straightforward fix in the repo's own code
     (e.g. a broken import, a missing config key, an incompatible
     dependency), go back to the original branch, delete the PMR branch,
     apply the minimal fix on a new branch, then re-run `uvx pimp-my-repo`
     from there.
  3. If the failure looks like a PMR bug or something you can't easily fix,
     stop and report what you found.

For context and reference on PMR, see https://github.com/asaf-kali/pimp-my-repo/blob/main/README.md.

Why legacy repos stay legacy

Adopting strict linting and type checking sounds great — until you run Ruff or Mypy for the first time and see 17,000 violations. Fixing them all before you can enforce a single rule isn't practical, so the tools stay off or "loose," and the debt compounds.

The baseline approach

pimp-my-repo skips the manual fix step entirely:

1. Configures tools in strict mode: Ruff with all rules enabled, Mypy with --strict (or ty with error-on-warning).
2. Suppresses all existing violations: automatically adds # noqa and # type: ignore / # ty: ignore to every current offender.
3. Commits the result: you get a clean, passing CI baseline immediately.

New code must comply from day one. Legacy violations are silenced but visible; fix them incrementally, at your own pace, without blocking anyone.

What gets added

• 🚀 uv — modern dependency management
• ✨ Ruff — linting and formatting, strict mode, all existing violations suppressed
• 🐍 Mypy — static type checking, strict mode, all existing errors suppressed
• ⚡ ty (opt-in via --ty) — Astral's fast type checker as a drop-in alternative to mypy
• 🏖️ pre-commit — hooks to enforce quality before every commit
• 🎢 just — task runner with install, test, and lint recipes out of the box
• 🏗️ CI (coming soon) — GitHub Actions or GitLab Pipeline configuration

Using ty instead of mypy

Pass --ty to replace the mypy boost with ty:

uvx pimp-my-repo --ty

ty runs dramatically faster than mypy and catches a different (often broader) set of type errors.

License

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