API Reference¶
jira2py exposes two complementary Jira Cloud layers:
from jira2py import JiraAPI— the low-level Jira REST facadefrom jira2py.helpers import JiraHelpers— the high-level workflow facade
High-level facade¶
from jira2py import JiraAPI
from jira2py.helpers import JiraHelpers
api = JiraAPI()
helpers = JiraHelpers(api)
helpers.auth
helpers.issues
helpers.search
helpers.comments
helpers.worklogs
helpers.attachments
helpers.metadata
helpers.links
helpers.filters
Helper methods return HelperResult objects with human-readable text plus optional structured data and raw_content.
Low-level facade¶
from jira2py import JiraAPI
jira = JiraAPI()
jira.issues
jira.search
jira.comments
jira.worklogs
jira.fields
jira.issue_links
jira.projects
jira.metadata
jira.filters
jira.attachments
jira.users
Modules¶
| Module | Property | Description |
|---|---|---|
| High-level Helpers | helpers.<group> |
Grouped helper facade returning HelperResult |
| JiraAPI | — | Entry point and low-level facade |
| Issues | jira.issues |
Create, read, edit, and transition issues |
| Issue Search | jira.search |
Search issues with JQL |
| Issue Comments | jira.comments |
List, add, update, and delete comments |
| Issue Worklogs | jira.worklogs |
List, add, update, and delete issue worklogs |
| Issue Fields | jira.fields |
List system and custom fields |
| Issue Links | jira.issue_links |
List issue links and link types; create and delete links |
| Projects | jira.projects |
Get, search, and list projects |
| Metadata | jira.metadata |
Statuses and priorities |
| Filters | jira.filters |
Search saved filters and fetch saved filter JQL |
| Attachments | jira.attachments |
List, read, download, upload, and delete attachments |
| Users | jira.users |
Search users and get the current user |
| Exceptions | — | Exception hierarchy |
Conventions¶
extra_params and extra_data¶
Most methods accept:
extra_params— extra query parameters merged into the request URLextra_data— extra request-body fields merged into the payload
Return types¶
- Low-level
JiraAPImethods return parsed Jira REST response bodies (dict,list, orNone) - High-level helpers return
HelperResult