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.7.tar.gz (102.6 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.7-py3-none-any.whl (38.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pimp_my_repo-0.2.7.tar.gz
  • Upload date:
  • Size: 102.6 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.7.tar.gz
Algorithm Hash digest
SHA256 0a4af235d6345f48b1541c8cc1a1d5584c7656ffebc1fe4110d6903c92aeacad
MD5 0e8d5eee599fcae35c6fb320bfec20dd
BLAKE2b-256 6b9fd2aefdcaee3017c5b48a22a73171f9b6d29bad60b2653eaa805d79fced21

See more details on using hashes here.

Provenance

The following attestation bundles were made for pimp_my_repo-0.2.7.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.7-py3-none-any.whl.

File metadata

  • Download URL: pimp_my_repo-0.2.7-py3-none-any.whl
  • Upload date:
  • Size: 38.9 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 07cc73d1e29646ba4694779513fce99ace8271ed6be2772d7e7d93bb3228d725
MD5 eca26bdf3a10684cdc76b8b990107201
BLAKE2b-256 ebdc2974b3f1ec9714a28a0842ca1db69d98425497640d7f06afdc165d37e7c4

See more details on using hashes here.

Provenance

The following attestation bundles were made for pimp_my_repo-0.2.7-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