prpolish 0.2.4

A CLI tool to generate PR titles and descriptions for Git repositories

prpolish: AI-Powered PR Helper

Supercharge your pull requests with AI-generated titles, descriptions, and quality checks!
Make every PR shine ✨

---

COMING SOON
Above: Example of prpolish generating a beautiful PR description and running vibe checks

---

Features

• PR Title & Description Generator: AI-powered, context-aware, and customizable.
• Vibe Check Warnings: Flags low-quality commits, missing tests, and more.
• CLI Interface: Simple, interactive, and scriptable.
• Custom Templates: Use your own PR templates (string or file).
• LLM-Powered: Uses OpenAI GPT for best results, with fallback heuristics.
• Failsafe Defaults: Always allows user editing and review.

---

Installation

# 1. Install dependencies
pip install -r requirements.txt

# 2. (Optional) Install GitHub CLI for auto PR creation
# https://cli.github.com/

---

Usage

# Generate PR title and description
prpolish generate [--template <str|path>] [--save, -s title|description|both] [--fast, -f]

# Generate only the PR title
prpolish generate-title [--template <str|path>] [--save, -s]

# Generate only the PR description
prpolish generate-desc [--template <str|path>] [--save, -s]

Flags

-save, -s: allows you to save either the title, description, or both (default) to a draft file
--fast, -f: automatically creates the PR and commits it

---

LLM-Powered PR Descriptions

1. Get your OpenAI API key from OpenAI
2. Set it in your environment:

export OPENAI_API_KEY=sk-...

If no API key is set, the tool falls back to a heuristic generator.

---

Custom PR Templates

You can provide your own template for the PR description using the --template flag. This can be either a string or a path to a file containing your template.

If you already have a pull_request_template.md, it will automatically detect it and use it.

---

License

_{Made by @yashg4509}