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 CI codecov 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.4.0.tar.gz (130.3 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.4.0-py3-none-any.whl (47.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pimp_my_repo-0.4.0.tar.gz
  • Upload date:
  • Size: 130.3 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.4.0.tar.gz
Algorithm Hash digest
SHA256 f4a0e401d98f1577f2cc18e10ba793dedf24a5ccbb691f64a0c5060be44346af
MD5 fa11f94c84b3e5ba915e63eb0c9ade5c
BLAKE2b-256 38fef0ca8fc33f86dca973d2a8c087e76dca561e941c41ffc2f723c9b40212ab

See more details on using hashes here.

Provenance

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

Publisher: ci.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.4.0-py3-none-any.whl.

File metadata

  • Download URL: pimp_my_repo-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 47.5 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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0ea3325095371c33571191f52375bad84eefb693b79d775c2548fc38e383acd6
MD5 fb6eff5e6d2285dbe4be54486cf0b35d
BLAKE2b-256 60f536b57776824d3f23b9ebffd2f5015c4bda3b23fbcd15b90527abf8280fa9

See more details on using hashes here.

Provenance

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

Publisher: ci.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