Metadata-Version: 2.4
Name: pimp-my-repo
Version: 0.1.2
Summary: 🪄 Enhance your Python repository by adding cutting-edge development tools
Project-URL: Homepage, https://github.com/asaf-kali/pimp-my-repo
Project-URL: Repository, https://github.com/asaf-kali/pimp-my-repo
Project-URL: Issues, https://github.com/asaf-kali/pimp-my-repo/issues
Author-email: Asaf Kali <asaf.kali@mail.huji.ac.il>
Requires-Python: >=3.14
Requires-Dist: pydantic~=2.12
Description-Content-Type: text/markdown

# Pimp My Repo

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

[![Test](https://github.com/asaf-kali/pimp-my-repo/actions/workflows/test.yml/badge.svg)](https://github.com/asaf-kali/pimp-my-repo/actions/workflows/test.yml)
[![Lint](https://github.com/asaf-kali/pimp-my-repo/actions/workflows/lint.yml/badge.svg)](https://github.com/asaf-kali/pimp-my-repo/actions/workflows/lint.yml)
[![Type Check](https://github.com/asaf-kali/pimp-my-repo/actions/workflows/type-check.yml/badge.svg)](https://github.com/asaf-kali/pimp-my-repo/actions/workflows/type-check.yml)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![Type checked: mypy](https://img.shields.io/badge/type%20check-mypy-22aa11)](http://mypy-lang.org/)

## Features

**pimp-my-repo** will help you:
- 🚀 Integrate [uv](https://docs.astral.sh/uv/) for modern dependency management.
- ✨ Configure [ruff](https://github.com/astral-sh/ruff) to keep your code clean and consistent.
- 🐍 Integrate [mypy](https://github.com/python/mypy) for static type checking to catch potential bugs early.
- 🏖️ Set up [pre-commit](https://pre-commit.com/) hooks to ensure code quality before changes are committed.
- 🎢 Generate a [justfile](https://github.com/casey/just) 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.

## Installation

Install **pimp-my-repo** globally with:

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

# With pipx:
pipx install pimp-my-repo
```
