pr-descriptor 0.1.0__tar.gz

pr_descriptor-0.1.0/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 2.4
+Name: pr-descriptor
+Version: 0.1.0
+Summary: AI-powered PR description generator using Claude
+Requires-Python: >=3.10
+Requires-Dist: anthropic>=0.40.0
+Requires-Dist: click>=8.1.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pyperclip>=1.9.0
+Requires-Dist: requests>=2.31.0

pr_descriptor-0.1.0/pr_descriptor.egg-info/PKG-INFO

@@ -0,0 +1,11 @@
+Metadata-Version: 2.4
+Name: pr-descriptor
+Version: 0.1.0
+Summary: AI-powered PR description generator using Claude
+Requires-Python: >=3.10
+Requires-Dist: anthropic>=0.40.0
+Requires-Dist: click>=8.1.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pyperclip>=1.9.0
+Requires-Dist: requests>=2.31.0

pr_descriptor-0.1.0/pr_descriptor.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+pyproject.toml
+pr_descriptor.egg-info/PKG-INFO
+pr_descriptor.egg-info/SOURCES.txt
+pr_descriptor.egg-info/dependency_links.txt
+pr_descriptor.egg-info/entry_points.txt
+pr_descriptor.egg-info/requires.txt
+pr_descriptor.egg-info/top_level.txt
+pr_writer/__init__.py
+pr_writer/ai_client.py
+pr_writer/cli.py
+pr_writer/git_utils.py
+pr_writer/platforms.py

pr_descriptor-0.1.0/pr_descriptor.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pr_descriptor-0.1.0/pr_descriptor.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pr-descriptor = pr_writer.cli:main

pr_descriptor-0.1.0/pr_descriptor.egg-info/requires.txt

@@ -0,0 +1,6 @@
+anthropic>=0.40.0
+click>=8.1.0
+rich>=13.0.0
+python-dotenv>=1.0.0
+pyperclip>=1.9.0
+requests>=2.31.0

pr_descriptor-0.1.0/pr_descriptor.egg-info/top_level.txt

@@ -0,0 +1 @@
+pr_writer

pr_descriptor-0.1.0/pr_writer/ai_client.py

@@ -0,0 +1,53 @@
+from typing import Iterator
+
+from anthropic import Anthropic
+
+from .git_utils import GitContext
+
+SYSTEM_PROMPT = """\
+You are an expert software engineer who writes clear, concise, and professional pull request descriptions.
+
+Given git context (branch name, commits, changed files, diff), generate a well-structured PR description \
+in GitHub-flavored Markdown using this exact format:
+
+## Summary
+A concise paragraph explaining what this PR does and the motivation behind it.
+
+## Changes
+- Bullet points listing the key changes
+
+## Testing
+Steps or notes on how to test these changes.
+
+## Breaking Changes
+List any breaking changes, or write "None" if there are none.
+
+## Related Issues
+Reference issue numbers mentioned in commits (e.g., Fixes #123), or write "None".
+
+Be specific and professional. Focus on the *why* as much as the *what*. No filler phrases.\
+"""
+
+
+def _build_prompt(ctx: GitContext) -> str:
+    commits = "\n".join(ctx.commits) if ctx.commits else "No commits"
+    files = "\n".join(ctx.changed_files) if ctx.changed_files else "No changed files"
+    return (
+        f"Branch: `{ctx.current_branch}` → `{ctx.base_branch}`\n\n"
+        f"Commits:\n{commits}\n\n"
+        f"Changed files:\n{files}\n\n"
+        f"Diff:\n```diff\n{ctx.diff}\n```"
+    )
+
+
+def stream_pr_description(ctx: GitContext) -> Iterator[str]:
+    """Stream the PR description token by token from Claude."""
+    client = Anthropic()
+    with client.messages.stream(
+        model="claude-sonnet-4-6",
+        max_tokens=1024,
+        system=SYSTEM_PROMPT,
+        messages=[{"role": "user", "content": _build_prompt(ctx)}],
+    ) as stream:
+        for text in stream.text_stream:
+            yield text

pr_descriptor-0.1.0/pr_writer/cli.py

@@ -0,0 +1,124 @@
+import os
+import sys
+from pathlib import Path
+
+import click
+from dotenv import load_dotenv
+from rich.console import Console
+from rich.markdown import Markdown
+from rich.panel import Panel
+
+from .ai_client import stream_pr_description
+from .git_utils import Platform, collect_git_context
+from .platforms import PlatformError, push_description
+
+console = Console()
+
+
+def _load_env() -> None:
+    load_dotenv()
+    load_dotenv(Path.home() / ".pr-writer" / ".env")
+
+
+@click.command()
+@click.option("--base", "-b", default="main", show_default=True, help="Base branch to compare against.")
+@click.option("--repo", "-r", default=".", show_default=True, help="Path to the git repository.")
+@click.option("--copy", "-c", is_flag=True, help="Copy the generated description to clipboard.")
+@click.option("--push", "-p", is_flag=True, help="Update the open PR on GitHub/Gitea with the description.")
+@click.option("--raw", is_flag=True, help="Print raw Markdown without the formatted preview panel.")
+@click.version_option(version="0.1.0")
+def main(base: str, repo: str, copy: bool, push: bool, raw: bool) -> None:
+    """Generate AI-powered PR descriptions from your git diff.
+
+    \b
+    Reads your local git history, sends the context to Claude, and streams
+    back a structured PR description. Supports GitHub and Gitea remotes.
+
+    \b
+    Examples:
+      pr-writer                      # compare current branch vs main
+      pr-writer --base develop       # compare vs develop
+      pr-writer --copy               # copy output to clipboard
+      pr-writer --push               # update the open PR description via API
+    """
+    _load_env()
+
+    if not os.getenv("ANTHROPIC_API_KEY"):
+        console.print("[red]Error:[/red] ANTHROPIC_API_KEY is not set.")
+        console.print("Add it to a [bold].env[/bold] file in your project or home directory.")
+        sys.exit(1)
+
+    # ── Collect git context ──────────────────────────────────────────────────
+    with console.status("[bold blue]Reading git context...", spinner="dots"):
+        try:
+            ctx = collect_git_context(repo, base)
+        except RuntimeError as exc:
+            console.print(f"[red]Git error:[/red] {exc}")
+            sys.exit(1)
+
+    if not ctx.commits and not ctx.diff:
+        console.print(
+            f"[yellow]No changes[/yellow] between "
+            f"[bold]{ctx.current_branch}[/bold] and [bold]{base}[/bold]."
+        )
+        sys.exit(0)
+
+    # ── Print summary line ───────────────────────────────────────────────────
+    remote_label = ""
+    if ctx.remote:
+        platform_name = "GitHub" if ctx.remote.platform == Platform.GITHUB else "Gitea"
+        remote_label = (
+            f"  [dim]Remote:[/dim] {platform_name} "
+            f"([dim]{ctx.remote.owner}/{ctx.remote.repo}[/dim])"
+        )
+
+    console.print(
+        f"[dim]Branch:[/dim] [bold cyan]{ctx.current_branch}[/bold cyan] → [bold]{base}[/bold]"
+        f"  [dim]Commits:[/dim] {len(ctx.commits)}"
+        f"  [dim]Files:[/dim] {len(ctx.changed_files)}"
+        + remote_label
+    )
+    console.print()
+
+    # ── Stream description from Claude ───────────────────────────────────────
+    console.print("[bold green]Generating PR description[/bold green]\n")
+    parts: list[str] = []
+    try:
+        for token in stream_pr_description(ctx):
+            console.print(token, end="")
+            parts.append(token)
+    except Exception as exc:
+        console.print(f"\n[red]API error:[/red] {exc}")
+        sys.exit(1)
+
+    description = "".join(parts)
+    console.print("\n")
+
+    # ── Formatted preview ────────────────────────────────────────────────────
+    if not raw:
+        console.print(
+            Panel(
+                Markdown(description),
+                title="[bold]Formatted Preview[/bold]",
+                border_style="dim",
+            )
+        )
+
+    # ── Copy to clipboard ────────────────────────────────────────────────────
+    if copy:
+        try:
+            import pyperclip  # noqa: PLC0415
+            pyperclip.copy(description)
+            console.print("[green]Copied to clipboard.[/green]")
+        except Exception as exc:
+            console.print(f"[yellow]Could not copy to clipboard:[/yellow] {exc}")
+
+    # ── Push to platform ─────────────────────────────────────────────────────
+    if push:
+        with console.status("[bold blue]Updating PR description...", spinner="dots"):
+            try:
+                pr_url = push_description(ctx, description)
+            except PlatformError as exc:
+                console.print(f"[red]Push failed:[/red] {exc}")
+                sys.exit(1)
+        console.print(f"[green]PR description updated:[/green] {pr_url}")

pr_descriptor-0.1.0/pr_writer/git_utils.py

@@ -0,0 +1,117 @@
+import re
+import subprocess
+from dataclasses import dataclass
+from enum import Enum
+from pathlib import Path
+from typing import List, Optional
+
+
+class Platform(Enum):
+    GITHUB = "github"
+    GITEA = "gitea"
+    UNKNOWN = "unknown"
+
+
+@dataclass
+class RemoteInfo:
+    platform: Platform
+    host: str
+    owner: str
+    repo: str
+    url: str
+
+
+@dataclass
+class GitContext:
+    current_branch: str
+    base_branch: str
+    commits: List[str]
+    diff: str
+    changed_files: List[str]
+    repo_path: str
+    remote: Optional[RemoteInfo] = None
+
+
+def _run(args: List[str], cwd: str) -> str:
+    """Run a git command and return stdout. Raises RuntimeError on failure."""
+    result = subprocess.run(
+        ["git"] + args,
+        cwd=cwd,
+        capture_output=True,
+        text=True,
+        encoding="utf-8",
+        errors="replace",
+    )
+    if result.returncode != 0:
+        raise RuntimeError(result.stderr.strip() or f"git {' '.join(args)} failed")
+    return result.stdout.strip()
+
+
+def parse_remote_url(url: str) -> Optional[RemoteInfo]:
+    """
+    Parse a git remote URL into a RemoteInfo.
+
+    Handles both HTTPS and SSH formats:
+      https://github.com/owner/repo.git
+      git@github.com:owner/repo.git
+    """
+    https_re = re.compile(r"https?://([^/]+)/([^/]+)/([^/]+?)(?:\.git)?$")
+    ssh_re = re.compile(r"git@([^:]+):([^/]+)/([^/]+?)(?:\.git)?$")
+
+    match = https_re.match(url) or ssh_re.match(url)
+    if not match:
+        return None
+
+    host, owner, repo = match.group(1), match.group(2), match.group(3)
+    platform = Platform.GITHUB if host == "github.com" else Platform.GITEA
+
+    return RemoteInfo(platform=platform, host=host, owner=owner, repo=repo, url=url)
+
+
+def get_remote_info(repo_path: str) -> Optional[RemoteInfo]:
+    try:
+        url = _run(["remote", "get-url", "origin"], repo_path)
+        return parse_remote_url(url)
+    except RuntimeError:
+        return None
+
+
+def get_current_branch(repo_path: str) -> str:
+    return _run(["branch", "--show-current"], repo_path)
+
+
+def get_commits(repo_path: str, base_branch: str) -> List[str]:
+    output = _run(
+        ["log", f"{base_branch}..HEAD", "--oneline", "--no-merges"],
+        repo_path,
+    )
+    return [line for line in output.splitlines() if line]
+
+
+def get_diff(repo_path: str, base_branch: str, max_chars: int = 14000) -> str:
+    diff = _run(["diff", f"{base_branch}...HEAD", "--no-color"], repo_path)
+    if len(diff) > max_chars:
+        diff = (
+            diff[:max_chars]
+            + f"\n\n... [diff truncated — {len(diff) - max_chars} additional chars omitted]"
+        )
+    return diff
+
+
+def get_changed_files(repo_path: str, base_branch: str) -> List[str]:
+    output = _run(["diff", f"{base_branch}...HEAD", "--name-status"], repo_path)
+    return [line for line in output.splitlines() if line]
+
+
+def collect_git_context(repo_path: str, base_branch: str) -> GitContext:
+    """Gather all git context needed to generate a PR description."""
+    resolved = str(Path(repo_path).resolve())
+    return GitContext(
+        current_branch=get_current_branch(resolved),
+        base_branch=base_branch,
+        commits=get_commits(resolved, base_branch),
+        diff=get_diff(resolved, base_branch),
+        changed_files=get_changed_files(resolved, base_branch),
+        repo_path=resolved,
+        remote=get_remote_info(resolved),
+    )

pr_descriptor-0.1.0/pr_writer/platforms.py

@@ -0,0 +1,114 @@
+import os
+from typing import Optional
+
+import requests
+
+from .git_utils import GitContext, Platform, RemoteInfo
+
+
+class PlatformError(Exception):
+    pass
+
+
+# ---------------------------------------------------------------------------
+# Header helpers
+# ---------------------------------------------------------------------------
+
+def _github_headers(token: str) -> dict:
+    return {
+        "Authorization": f"Bearer {token}",
+        "Accept": "application/vnd.github+json",
+        "X-GitHub-Api-Version": "2022-11-28",
+    }
+
+
+def _gitea_headers(token: str) -> dict:
+    return {
+        "Authorization": f"token {token}",
+        "Content-Type": "application/json",
+    }
+
+
+# ---------------------------------------------------------------------------
+# PR lookup
+# ---------------------------------------------------------------------------
+
+def _find_github_pr(remote: RemoteInfo, branch: str, token: str) -> Optional[int]:
+    url = f"https://api.github.com/repos/{remote.owner}/{remote.repo}/pulls"
+    resp = requests.get(
+        url,
+        headers=_github_headers(token),
+        params={"state": "open", "head": f"{remote.owner}:{branch}"},
+        timeout=10,
+    )
+    resp.raise_for_status()
+    prs = resp.json()
+    return prs[0]["number"] if prs else None
+
+
+def _find_gitea_pr(remote: RemoteInfo, branch: str, token: str) -> Optional[int]:
+    url = f"https://{remote.host}/api/v1/repos/{remote.owner}/{remote.repo}/pulls"
+    resp = requests.get(
+        url,
+        headers=_gitea_headers(token),
+        params={"state": "open", "limit": 50},
+        timeout=10,
+    )
+    resp.raise_for_status()
+    for pr in resp.json():
+        head = pr.get("head", {})
+        if head.get("ref") == branch or head.get("label") == branch:
+            return pr["number"]
+    return None
+
+
+# ---------------------------------------------------------------------------
+# Public API
+# ---------------------------------------------------------------------------
+
+def push_description(ctx: GitContext, description: str) -> str:
+    """
+    Find the open PR for the current branch and update its description.
+    Returns the PR URL on success. Raises PlatformError on failure.
+    """
+    remote = ctx.remote
+    if remote is None:
+        raise PlatformError("Could not detect a git remote. Is 'origin' set?")
+
+    if remote.platform == Platform.GITHUB:
+        token = os.getenv("GITHUB_TOKEN")
+        if not token:
+            raise PlatformError("GITHUB_TOKEN is not set in your environment.")
+
+        pr_number = _find_github_pr(remote, ctx.current_branch, token)
+        if pr_number is None:
+            raise PlatformError(
+                f"No open PR found for branch '{ctx.current_branch}' "
+                f"on {remote.owner}/{remote.repo}."
+            )
+
+        url = f"https://api.github.com/repos/{remote.owner}/{remote.repo}/pulls/{pr_number}"
+        resp = requests.patch(
+            url, headers=_github_headers(token), json={"body": description}, timeout=10
+        )
+        resp.raise_for_status()
+        return f"https://github.com/{remote.owner}/{remote.repo}/pull/{pr_number}"
+
+    else:  # Gitea
+        token = os.getenv("GITEA_TOKEN")
+        if not token:
+            raise PlatformError("GITEA_TOKEN is not set in your environment.")
+
+        pr_number = _find_gitea_pr(remote, ctx.current_branch, token)
+        if pr_number is None:
+            raise PlatformError(
+                f"No open PR found for branch '{ctx.current_branch}' "
+                f"on {remote.owner}/{remote.repo}."
+            )
+
+        url = f"https://{remote.host}/api/v1/repos/{remote.owner}/{remote.repo}/pulls/{pr_number}"
+        resp = requests.patch(
+            url, headers=_gitea_headers(token), json={"body": description}, timeout=10
+        )
+        resp.raise_for_status()
+        return f"https://{remote.host}/{remote.owner}/{remote.repo}/pulls/{pr_number}"

pr_descriptor-0.1.0/pyproject.toml

@@ -0,0 +1,24 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "pr-descriptor"
+version = "0.1.0"
+description = "AI-powered PR description generator using Claude"
+requires-python = ">=3.10"
+dependencies = [
+    "anthropic>=0.40.0",
+    "click>=8.1.0",
+    "rich>=13.0.0",
+    "python-dotenv>=1.0.0",
+    "pyperclip>=1.9.0",
+    "requests>=2.31.0",
+]
+
+[project.scripts]
+pr-descriptor = "pr_writer.cli:main"
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["pr_writer*"]

pr_descriptor-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+