Skip to main content

usePR

AI-powered PR summary generator for Git repositories

Explore the Documentation »
Report Bug · Request Feature

Table of Contents
  1. About
  2. Quick Start
  3. Usage
  4. Development
  5. Contributing
  6. License

About

usepr (usepr) is a Python CLI that generates pull request summaries from your git commits using AI (DSPy). It analyzes your commit history and produces well-structured, meaningful PR descriptions.

  • AI-powered summaries - Uses DSPy ChainOfThought to understand and summarize your changes
  • Template support - Automatically detects and uses PR templates from your repository
  • Flexible diffing - Generate summaries between any branches, tags, or commits
  • Interactive prompts - Guided workflow with base branch and issue selection
  • Clipboard integration - Copy generated summaries directly to clipboard
  • Model override - Use different LLM models via the -m flag

(back to top)

Quick Start

uv tool install usepr

Install with pipx (alternative)

pipx install usepr

Generate a PR summary

usepr generate

This will prompt you to select a base branch, optionally link related issues, and generate a summary from your commits.

(back to top)

Usage

Generate a PR Summary

usepr generate

The interactive workflow will:

  1. Detect your repository's default branch
  2. Prompt for a base branch to diff against
  3. Gather commits between base and HEAD
  4. Ask for related issues (optional)
  5. Detect and offer PR templates (if any)
  6. Generate and display the summary
  7. Offer to copy to clipboard

Use a Custom Model

Set your API key as an environment variable for the provider you're using:

export OPENAI_API_KEY="sk-..."
export ANTHROPIC_API_KEY="sk-ant-..."

Then run with the provider/model format:

usepr generate -m openai/gpt-4o
usepr generate -m anthropic/claude-sonnet-4-20250514
usepr generate -m openrouter/google/gemini-2.5-flash

Use the Short Alias

usepr gen

Available Commands

generate (gen)  Generate a PR summary from commits
help            Show help

(back to top)

Development

Common tasks:

uv run poe clean-full
uv run poe test
uv run poe lint
uv run poe format

(back to top)

Contributing

Quick workflow:

  1. Fork and branch: git checkout -b feature/name
  2. Make changes
  3. Run checks: uv run poe clean-full
  4. Commit and push
  5. Open a Pull Request

(back to top)

License

License information has not been added yet.

(back to top)


Built by thememium

Metadata

Release files for usepr 0.1.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for usepr 0.1.8
File Size Uploaded Provenance Actions
usepr-0.1.8.tar.gz 12.7 kB Without provenance Details for usepr-0.1.8.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for usepr 0.1.8
File Interpreter ABI Platform Actions
usepr-0.1.8-py3-none-any.whl Python 3 none any Details for usepr-0.1.8-py3-none-any.whl

Total release size: 29.4 kB

Release files / usepr-0.1.8.tar.gz

Download URL usepr-0.1.8.tar.gz
Size 12.7 kB
Tags Source
SHA-256 checksum
How to use checksums
9d9480fd1a692d2285e818e8c3f1673a307581b21accfd0bc324954d5280ca8a
BLAKE2b-256 checksum
How to use checksums
c4d3a3e3051cf675604f675e926ff008a8d02985e1ae35e14c56865b3e27ba77
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / usepr-0.1.8-py3-none-any.whl

Download URL usepr-0.1.8-py3-none-any.whl
Size 16.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
28960cfd147c5639caee49d2c97960ab6aeedf2320b1910ac2abe1e9620a83dd
BLAKE2b-256 checksum
How to use checksums
e7b8b3bb77256a10130218ee33d45cae6bf5953883294280f749e1e4fc15bcef
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.1 {"installer":{"name":"uv","version":"0.13.1","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for usepr 0.1.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page