pyJiraV3

A modern, fully-typed Python client for the Jira Cloud REST API v3.

Built on httpx and Pydantic v2. Supports both synchronous and asynchronous usage.

Features

• 23 resource types covering the full Jira Cloud REST API v3

• Sync + async – every method works with both httpx.Client and httpx.AsyncClient

• Fully typed – Pydantic v2 models with snake_case attributes and camelCase aliases

• Auto-pagination – built-in Paginator / AsyncPaginator iterators

• Typed exceptions – structured error hierarchy mapped from HTTP status codes

• Extensible models – extra='allow' preserves unknown fields (custom fields, new API additions)

Quick Example

from pyjira import JiraClient

with JiraClient(domain='mycompany', email='you@example.com', api_token='tok') as client:
    issue = client.issues.get('PROJ-123')
    print(issue.key, issue.fields.summary)

Getting Started

• Installation
  • Requirements
  • Install from PyPI
  • Install from Source
  • Dependencies
  • Verify Installation
• Quick Start
  • Create a Client
  • Use as a Context Manager
  • Fetch an Issue
  • Search with JQL
  • Auto-Paginated Search
  • Create an Issue
  • Async Usage
  • Next Steps
• Authentication
  • Generate an API Token
  • Connect by Domain
  • Connect by Base URL
  • Client Options
  • Environment Variables
  • Connection Lifecycle

Advanced

• Pagination
  • Manual Pagination
  • Auto-Pagination
  • Using Paginator Directly
  • Paginator API
• Error Handling
  • Basic Usage
  • Exception Hierarchy
  • Exception Attributes
  • Handling Rate Limits
  • Inspecting Raw Responses
• Models
  • Base Classes
  • Field Naming
  • Accessing Custom Fields
  • Core Models
• Async Usage
  • AsyncJiraClient
  • Context Manager
  • Concurrent Requests
  • Async Pagination
  • Resource Parity

Development

• Contributing
• Changelog