Skip to main content

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

Project description

Pimp My Repo

🧙🏼‍♂️ A CLI wizard designed to modernize your Python repositories by adding essential development tools.

PyPI Test Lint Type Check Ruff Type checked: mypy

Features

pimp-my-repo will help you:

  • 🚀 Integrate uv for modern dependency management.
  • ✨ Configure ruff to keep your code clean and consistent.
  • 🐍 Integrate mypy for static type checking to catch potential bugs early.
  • 🏖️ Set up pre-commit hooks to ensure code quality before changes are committed.
  • 🎢 Generate a justfile with common commands like install, test and lint.
  • 🏗️ Add CI job configurations for GitHub Actions or GitLab Pipeline to enforce your rules in a continuous integration environment.

Why?

Adopting strict linting and type checking in a legacy Python repo is painful — there are hundreds of existing violations to deal with before you can even turn the rules on. pimp-my-repo automates that process: it configures common linting tools in strict mode, automatically suppresses all existing violations (via # noqa / # type: ignore comments), and commits the result. The goal is a clean baseline instantly — after which new code must comply. Once merged, you can gradually revisit and fix the suppressed issues at your own pace.

Usage

In your repository root, run:

uvx pimp-my-repo

Alternatively, install pimp-my-repo globally and use it in any repository:

# With UV:
uv tool install pimp-my-repo

# With pipx:
pipx install pimp-my-repo

License

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pimp_my_repo-0.2.5.tar.gz (101.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pimp_my_repo-0.2.5-py3-none-any.whl (37.3 kB view details)

Uploaded Python 3

File details

Details for the file pimp_my_repo-0.2.5.tar.gz.

File metadata

  • Download URL: pimp_my_repo-0.2.5.tar.gz
  • Upload date:
  • Size: 101.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pimp_my_repo-0.2.5.tar.gz
Algorithm Hash digest
SHA256 975839bf2507079ef35cd96827146ad10d99b31352ed2d466b83435635fdbc46
MD5 c8ebe93dcee99ba2257f8739678c0946
BLAKE2b-256 4761b973cb5b121b698f9956b73f7b400602eab52d4f64053c08c92a9a548fc6

See more details on using hashes here.

Provenance

The following attestation bundles were made for pimp_my_repo-0.2.5.tar.gz:

Publisher: release.yml on asaf-kali/pimp-my-repo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pimp_my_repo-0.2.5-py3-none-any.whl.

File metadata

  • Download URL: pimp_my_repo-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 37.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pimp_my_repo-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8063e3299f7f11319a5b86ba3ceec55c25a6e225c559b8c65ee87d2c41b84f22
MD5 dc91f5a50ae1516ff5f6e07e0df02c80
BLAKE2b-256 7bd508d7c348c90e0bbcd5429e1e66c2b01e9cd8b320401c2b71c321fd9d11bc

See more details on using hashes here.

Provenance

The following attestation bundles were made for pimp_my_repo-0.2.5-py3-none-any.whl:

Publisher: release.yml on asaf-kali/pimp-my-repo

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page