ticket2pr 0.1.0__tar.gz

ticket2pr-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Ben Gabay
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ticket2pr-0.1.0/PKG-INFO

@@ -0,0 +1,83 @@
+Metadata-Version: 2.4
+Name: ticket2pr
+Version: 0.1.0
+Summary: Automate Jira ticket to GitHub PR workflow
+Home-page: https://github.com/bengabay11/ticket2pr
+Author: Ben Gabay
+Author-email: ben.gabay38@gmail.com
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: claude-agent-sdk>=0.1.25
+Requires-Dist: colorlog>=6.9.0
+Requires-Dist: gitpython>=3.1.46
+Requires-Dist: jira>=3.10.5
+Requires-Dist: pydantic>=2.11.5
+Requires-Dist: pydantic-settings>=2.9.1
+Requires-Dist: pygithub>=2.8.1
+Requires-Dist: python-dotenv>=1.1.0
+Requires-Dist: rich>=14.0.0
+Requires-Dist: tomli-w>=1.2.0
+Requires-Dist: typer>=0.21.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# Ticket2PR
+
+Ticket2PR is an AI-powered automation tool designed to streamline the process of converting development tickets into ready-to-merge pull requests. It integrates with Jira and GitHub to automate tasks such as branch creation, commit message generation, code linting fixes, and pull request content generation, significantly reducing manual effort and accelerating development workflows.
+
+## What's Included
+
+Ticket2PR provides a comprehensive set of features to automate your development workflow:
+
+- **🚀 Automated Workflow:** Orchestrates the entire process from ticket to pull request, handling branch creation, commit message generation, and PR content.
+- **🤖 AI-Powered Agents:** Utilizes specialized agents for tasks like crafting intelligent commit messages, automatically fixing pre-commit issues, and assisting with ticket resolution.
+- **🔗 Jira Integration:** Connects with Jira to fetch ticket details, enabling context-aware automation.
+- **🐙 GitHub Integration:** Interacts with GitHub for branch management, pull request creation, and status updates.
+
+## Prerequisites
+
+- **Jira Account and API Token:** An account with access to a Jira instance and a valid API token with necessary permissions to view tickets.
+- **GitHub Account and Personal Access Token:** A GitHub account with permissions to create branches and pull requests in your target repository, and a [Personal Access Token (PAT)](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) with `repo` scope for GitHub API access.
+- **Claude Code API Token:** Obtain an API token for Claude Code for AI-powered code assistance.
+
+## Getting Started
+
+Follow these steps to set up and start using Ticket2PR:
+
+### Installation
+
+You can install `ticket2pr` directly from PyPI:
+
+```sh
+pip install ticket2pr
+```
+
+### Configuration
+
+Ticket2PR automatically guides you through the initial configuration process the first time you run the CLI.
+
+To re-initialize the interactive configuration session, run:
+
+```sh
+ticket2pr init
+```
+
+Alternatively, you can manually configure settings by editing the `~/.ticket2pr/config.toml` file or by setting environment variables.
+
+### Usage
+
+Run the Ticket2PR CLI to create a pull request from a Jira ticket:
+
+```sh
+ticket2pr run <JIRA_ISSUE_KEY>
+```
+
+Replace `<JIRA_ISSUE_KEY>` with the actual ID of your Jira ticket (e.g., `PROJ-123`).
+
+## License
+
+This project is open-sourced under the terms of the [LICENSE](LICENSE).

ticket2pr-0.1.0/README.md

@@ -0,0 +1,56 @@
+# Ticket2PR
+
+Ticket2PR is an AI-powered automation tool designed to streamline the process of converting development tickets into ready-to-merge pull requests. It integrates with Jira and GitHub to automate tasks such as branch creation, commit message generation, code linting fixes, and pull request content generation, significantly reducing manual effort and accelerating development workflows.
+
+## What's Included
+
+Ticket2PR provides a comprehensive set of features to automate your development workflow:
+
+- **🚀 Automated Workflow:** Orchestrates the entire process from ticket to pull request, handling branch creation, commit message generation, and PR content.
+- **🤖 AI-Powered Agents:** Utilizes specialized agents for tasks like crafting intelligent commit messages, automatically fixing pre-commit issues, and assisting with ticket resolution.
+- **🔗 Jira Integration:** Connects with Jira to fetch ticket details, enabling context-aware automation.
+- **🐙 GitHub Integration:** Interacts with GitHub for branch management, pull request creation, and status updates.
+
+## Prerequisites
+
+- **Jira Account and API Token:** An account with access to a Jira instance and a valid API token with necessary permissions to view tickets.
+- **GitHub Account and Personal Access Token:** A GitHub account with permissions to create branches and pull requests in your target repository, and a [Personal Access Token (PAT)](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) with `repo` scope for GitHub API access.
+- **Claude Code API Token:** Obtain an API token for Claude Code for AI-powered code assistance.
+
+## Getting Started
+
+Follow these steps to set up and start using Ticket2PR:
+
+### Installation
+
+You can install `ticket2pr` directly from PyPI:
+
+```sh
+pip install ticket2pr
+```
+
+### Configuration
+
+Ticket2PR automatically guides you through the initial configuration process the first time you run the CLI.
+
+To re-initialize the interactive configuration session, run:
+
+```sh
+ticket2pr init
+```
+
+Alternatively, you can manually configure settings by editing the `~/.ticket2pr/config.toml` file or by setting environment variables.
+
+### Usage
+
+Run the Ticket2PR CLI to create a pull request from a Jira ticket:
+
+```sh
+ticket2pr run <JIRA_ISSUE_KEY>
+```
+
+Replace `<JIRA_ISSUE_KEY>` with the actual ID of your Jira ticket (e.g., `PROJ-123`).
+
+## License
+
+This project is open-sourced under the terms of the [LICENSE](LICENSE).

ticket2pr-0.1.0/pyproject.toml

@@ -0,0 +1,35 @@
+[project]
+name = "ticket2pr"
+version = "0.1.0"
+description = "Automate Jira ticket to GitHub PR workflow"
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "claude-agent-sdk>=0.1.25",
+    "colorlog>=6.9.0",
+    "gitpython>=3.1.46",
+    "jira>=3.10.5",
+    "pydantic>=2.11.5",
+    "pydantic-settings>=2.9.1",
+    "pygithub>=2.8.1",
+    "python-dotenv>=1.1.0",
+    "rich>=14.0.0",
+    "tomli-w>=1.2.0",
+    "typer>=0.21.1",
+]
+
+[project.scripts]
+ticket2pr = "src.cli:cli_main"
+
+[dependency-groups]
+dev = [
+    "absolufy-imports>=0.3.1",
+    "bandit>=1.8.3",
+    "codespell>=2.4.1",
+    "mypy>=1.16.0",
+    "pre-commit>=4.2.0",
+    "pydantic[mypy]>=2.11.5",
+    "pytest>=8.3.5",
+    "pytest-cases>=3.8.6",
+    "ruff>=0.11.12",
+]

ticket2pr-0.1.0/setup.cfg

@@ -0,0 +1,10 @@
+[bdist_wheel]
+universal = 1
+
+[metadata]
+license_file = LICENSE
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

ticket2pr-0.1.0/setup.py

@@ -0,0 +1,60 @@
+"""Setup script for ticket2pr package."""
+
+from setuptools import find_packages, setup
+
+# Read the long description from README
+with open("README.md", encoding="utf-8") as f:
+    long_description = f.read()
+
+setup(
+    name="ticket2pr",
+    version="0.1.0",
+    author="Ben Gabay",
+    author_email="ben.gabay38@gmail.com",
+    description="Automate Jira ticket to GitHub PR workflow",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    url="https://github.com/bengabay11/ticket2pr",
+    packages=find_packages(),
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.13",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.13",
+    install_requires=[
+        "claude-agent-sdk>=0.1.25",
+        "colorlog>=6.9.0",
+        "gitpython>=3.1.46",
+        "jira>=3.10.5",
+        "pydantic>=2.11.5",
+        "pydantic-settings>=2.9.1",
+        "pygithub>=2.8.1",
+        "python-dotenv>=1.1.0",
+        "rich>=14.0.0",
+        "tomli-w>=1.2.0",
+        "typer>=0.21.1",
+    ],
+    extras_require={
+        "dev": [
+            "absolufy-imports>=0.3.1",
+            "bandit>=1.8.3",
+            "codespell>=2.4.1",
+            "mypy>=1.16.0",
+            "pre-commit>=4.2.0",
+            "pytest>=8.3.5",
+            "pytest-cases>=3.8.6",
+            "ruff>=0.11.12",
+        ],
+    },
+    entry_points={
+        "console_scripts": [
+            "ticket2pr=src.cli:cli_main",
+        ],
+    },
+    include_package_data=True,
+    zip_safe=False,
+)

ticket2pr-0.1.0/src/branch_creator.py

@@ -0,0 +1,49 @@
+import re
+
+from src.clients.github_client import GitHubClient
+from src.clients.jira_client import JiraClient, JiraIssue
+
+
+def sanitize_branch_name(name: str, max_length: int = 100) -> str:
+    name = name.lower()
+    # Replace any character that's not a lowercase letter, digit, or hyphen with a hyphen
+    name = re.sub(r"[^a-z0-9-]", "-", name)
+    # Replace one or more consecutive hyphens with a single hyphen
+    name = re.sub(r"-+", "-", name)
+    name = name.strip("-")
+    if len(name) > max_length:
+        name = name[:max_length].rstrip("-")
+    return name
+
+
+def generate_branch_name(
+    issue_key: str,
+    issue_summary: str,
+    issue_type: str | None = None,
+    max_length: int = 255,
+) -> str:
+    sanitized_summary = sanitize_branch_name(issue_summary)
+    branch_name = f"{issue_key}-{sanitized_summary}"
+    if issue_type:
+        branch_name = f"{issue_type.lower()}/{branch_name}"
+
+    if len(branch_name) > max_length:
+        branch_name = branch_name[:max_length].rstrip("-")
+
+    return branch_name
+
+
+def create_branch_from_jira_issue(
+    jira_issue: JiraIssue,
+    jira_client: JiraClient,
+    github_client: GitHubClient,
+    base_branch: str = "main",
+) -> str:
+    branch_name = generate_branch_name(jira_issue.key, jira_issue.summary, jira_issue.type)
+    # TODO: Consider replacing the 2 next lines with local git client
+    base_ref = github_client.get_base_branch_ref(base_branch)
+    branch_url = github_client.create_branch(branch_name, base_ref)
+
+    jira_client.link_branch(jira_issue.key, branch_url, branch_name)
+
+    return branch_name

ticket2pr-0.1.0/src/cli.py

@@ -0,0 +1,211 @@
+from __future__ import annotations
+
+import asyncio
+import sys
+from pathlib import Path
+from typing import TYPE_CHECKING
+
+import typer
+
+from src.console_utils import (
+    format_dim,
+    format_success_with_checkmark,
+    format_yellow,
+    get_status,
+    print_empty_line,
+    print_error,
+    print_error_inline,
+    print_info,
+    print_label_value,
+    print_success,
+    print_warning,
+)
+from src.enhanced_git import EnhancedGit
+from src.logging_setup import LoggerHandlerType, SetupLoggerParams, setup_logger
+from src.settings import AppSettings
+from src.shell.claude_auth_status import is_claude_logged_in
+
+if TYPE_CHECKING:
+    from src.clients.github_client import GitHubClient
+    from src.clients.jira_client import JiraClient
+
+app = typer.Typer(
+    name="ticket2pr",
+    help="Automate Jira ticket to GitHub PR workflow",
+    add_completion=False,
+    rich_markup_mode="rich",
+    context_settings={"help_option_names": ["-h", "--help"]},
+)
+
+
+def _load_settings() -> AppSettings:
+    from dotenv import load_dotenv
+
+    load_dotenv()
+    try:
+        return AppSettings()
+    except Exception as e:
+        print_error_inline(f"loading settings: {e}")
+        sys.exit(1)
+
+
+def _initialize_clients(settings: AppSettings) -> tuple[GitHubClient, JiraClient, EnhancedGit]:
+    from src.clients.github_client import GitHubClient
+    from src.clients.jira_client import JiraClient
+    from src.enhanced_git import EnhancedGit
+
+    github_client = GitHubClient(
+        github_token=settings.github.api_token,
+        repo_full_name=settings.github.repo_full_name,
+    )
+    jira_client = JiraClient(
+        url=settings.jira.base_url,
+        username=settings.jira.username,
+        password=settings.jira.api_token,
+    )
+    git = EnhancedGit(settings.core.workspace_path)
+    return github_client, jira_client, git
+
+
+def _init() -> None:
+    from src.settings import DEFAULT_CONFIG_DIR
+    from src.settings_init import initialize_settings
+
+    config_path = DEFAULT_CONFIG_DIR / "config.toml"
+    initialize_settings(config_path)
+
+
+async def workflow_with_prints(
+    jira_issue_key: str,
+    workspace_path: Path,
+    base_branch: str,
+    github_client: GitHubClient,
+    jira_client: JiraClient,
+    local_git: EnhancedGit,
+    mcp_config_path: Path | None = None,
+) -> None:
+    header_msg = f"Running workflow for {format_yellow(jira_issue_key)}"
+    print_info(header_msg)
+    print_label_value("Workspace", workspace_path)
+    print_label_value("Base branch", base_branch)
+    print_label_value("Github repository", github_client.repo.full_name)
+    print_empty_line()
+
+    from src.workflow import workflow
+
+    result = await workflow(
+        github_client=github_client,
+        jira_client=jira_client,
+        jira_issue_key=jira_issue_key,
+        git=local_git,
+        base_branch=base_branch,
+        mcp_config_path=mcp_config_path,
+    )
+
+    success_msg = format_success_with_checkmark("Workflow completed successfully!")
+    issue_msg = format_dim(f"Issue: {result.jira_issue_permalink}")
+    pr_msg = format_dim(f"Pull Request: {result.pr_url}")
+    branch_msg = format_dim(f"Branch: {result.branch_name}")
+    base_branch_msg = format_dim(f"Base Branch: {base_branch}")
+
+    final_msg = "\n".join([success_msg, issue_msg, pr_msg, branch_msg, base_branch_msg])
+    print_success(final_msg)
+
+
+@app.command()
+def run(
+    jira_issue_key: str = typer.Argument(..., help="Jira issue key (e.g., PROJ-123)"),
+    workspace_path: Path | None = typer.Option(  # noqa: B008
+        None, "--workspace-path", "-w", help="Workspace path (overrides settings)"
+    ),
+    base_branch: str | None = typer.Option(
+        None, "--base-branch", "-b", help="Base branch (overrides settings)"
+    ),
+    mcp_config_path: Path | None = typer.Option(  # noqa: B008
+        None, "--mcp-config-path", "-m", help="Path to mcp.json config file for Claude agents"
+    ),
+) -> None:
+    """Execute the workflow for a specific Jira ticket."""
+
+    settings = _load_settings()
+
+    if not is_claude_logged_in():
+        hint = "Run /login or set the 'ANTHROPIC_API_KEY' environment variable."
+        message = "Claude Code authentication not found."
+        print_error(message)
+        print_label_value("Hint", hint)
+        sys.exit(1)
+
+    final_workspace_path = workspace_path or settings.core.workspace_path
+    final_base_branch = base_branch or settings.core.base_branch
+
+    setup_logger(
+        SetupLoggerParams(
+            level=settings.logging.min_log_level,
+            handler_types={LoggerHandlerType.STREAM, LoggerHandlerType.FILE},
+            file_path=settings.logging.log_file_path,
+        )
+    )
+
+    with get_status("Initializing clients...", spinner="dots"):
+        try:
+            github_client, jira_client, local_git = _initialize_clients(settings)
+        except Exception as e:
+            print_error(str(e))
+            sys.exit(1)
+
+    try:
+        asyncio.run(
+            workflow_with_prints(
+                jira_issue_key,
+                final_workspace_path,
+                final_base_branch,
+                github_client,
+                jira_client,
+                local_git,
+                mcp_config_path,
+            )
+        )
+    except KeyboardInterrupt:
+        print_empty_line()
+        print_warning("Workflow interrupted by user")
+        sys.exit(1)
+    except Exception as e:
+        print_error(str(e), title="Error")
+        sys.exit(1)
+
+
+@app.command()
+def init() -> None:
+    """Initialize settings configuration."""
+    _init()
+
+
+@app.command(name="help")
+def help_command(ctx: typer.Context) -> None:
+    """Show help information."""
+    typer.echo(ctx.find_root().get_help())
+
+
+def settings_exist() -> bool:
+    config_file_path = Path.home() / ".ticket2pr" / "config.toml"
+    return config_file_path.exists()
+
+
+@app.callback(invoke_without_command=True)
+def main(ctx: typer.Context) -> None:
+    if not settings_exist():
+        _init()
+        sys.exit(0)
+
+    if ctx.invoked_subcommand is None:
+        typer.echo(ctx.get_help())
+
+
+def cli_main() -> None:
+    """Entry point for the CLI."""
+    app()
+
+
+if __name__ == "__main__":
+    cli_main()