Metadata-Version: 2.4
Name: ticket2pr
Version: 0.3.6
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.10
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
Requires-Dist: typing_extensions>=4.0.0
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).
