Python Jira¶
Python library to work with Jira APIs
- 1. Installation
- 2. Examples
- 3. jirashell
- 4. Advanced
- 5. Contributing
- 6. API Documentation
- 6.1. jira package
- 6.1.1. jira.client module
cloud_api()
experimental_atlassian_api()
translate_resource_args()
ResultList
QshGenerator
JiraCookieAuth
TokenAuth
JIRA
JIRA.DEFAULT_OPTIONS
JIRA.checked_version
JIRA.JIRA_BASE_URL
JIRA.AGILE_BASE_URL
JIRA.__init__()
JIRA.server_url
JIRA.close()
JIRA.client_info()
JIRA.find()
JIRA.async_do()
JIRA.application_properties()
JIRA.set_application_property()
JIRA.applicationlinks()
JIRA.attachment()
JIRA.attachment_meta()
JIRA.add_attachment()
JIRA.delete_attachment()
JIRA.component()
JIRA.create_component()
JIRA.component_count_related_issues()
JIRA.delete_component()
JIRA.custom_field_option()
JIRA.dashboards()
JIRA.dashboard()
JIRA.create_dashboard()
JIRA.copy_dashboard()
JIRA.update_dashboard_automatic_refresh_minutes()
JIRA.dashboard_item_property_keys()
JIRA.dashboard_item_property()
JIRA.set_dashboard_item_property()
JIRA.dashboard_gadgets()
JIRA.all_dashboard_gadgets()
JIRA.add_gadget_to_dashboard()
JIRA.fields()
JIRA.filter()
JIRA.favourite_filters()
JIRA.create_filter()
JIRA.update_filter()
JIRA.group()
JIRA.groups()
JIRA.group_members()
JIRA.add_group()
JIRA.remove_group()
JIRA.issue()
JIRA.create_issue()
JIRA.create_issues()
JIRA.supports_service_desk()
JIRA.create_customer()
JIRA.service_desks()
JIRA.service_desk()
JIRA.create_customer_request()
JIRA.createmeta_issuetypes()
JIRA.createmeta_fieldtypes()
JIRA.createmeta()
JIRA.assign_issue()
JIRA.comments()
JIRA.comment()
JIRA.add_comment()
JIRA.editmeta()
JIRA.remote_links()
JIRA.remote_link()
JIRA.add_remote_link()
JIRA.add_simple_link()
JIRA.transitions()
JIRA.find_transitionid_by_name()
JIRA.transition_issue()
JIRA.votes()
JIRA.project_issue_security_level_scheme()
JIRA.project_notification_scheme()
JIRA.project_permissionscheme()
JIRA.project_priority_scheme()
JIRA.project_workflow_scheme()
JIRA.add_vote()
JIRA.remove_vote()
JIRA.watchers()
JIRA.add_watcher()
JIRA.remove_watcher()
JIRA.worklogs()
JIRA.worklog()
JIRA.add_worklog()
JIRA.issue_properties()
JIRA.issue_property()
JIRA.add_issue_property()
JIRA.create_issue_link()
JIRA.delete_issue_link()
JIRA.issue_link()
JIRA.issue_link_types()
JIRA.issue_link_type()
JIRA.issue_types()
JIRA.project_issue_types()
JIRA.project_issue_fields()
JIRA.issue_type()
JIRA.issue_type_by_name()
JIRA.request_types()
JIRA.request_type_by_name()
JIRA.my_permissions()
JIRA.priorities()
JIRA.priority()
JIRA.projects()
JIRA.project()
JIRA.project_avatars()
JIRA.create_temp_project_avatar()
JIRA.confirm_project_avatar()
JIRA.set_project_avatar()
JIRA.delete_project_avatar()
JIRA.project_components()
JIRA.project_versions()
JIRA.get_project_version_by_name()
JIRA.rename_version()
JIRA.project_roles()
JIRA.project_role()
JIRA.resolutions()
JIRA.resolution()
JIRA.search_issues()
JIRA.security_level()
JIRA.server_info()
JIRA.myself()
JIRA.statuses()
JIRA.issue_types_for_project()
JIRA.status()
JIRA.statuscategories()
JIRA.statuscategory()
JIRA.user()
JIRA.search_assignable_users_for_projects()
JIRA.search_assignable_users_for_issues()
JIRA.user_avatars()
JIRA.create_temp_user_avatar()
JIRA.confirm_user_avatar()
JIRA.set_user_avatar()
JIRA.delete_user_avatar()
JIRA.delete_remote_link()
JIRA.search_users()
JIRA.search_allowed_users_for_issue()
JIRA.create_version()
JIRA.move_version()
JIRA.version()
JIRA.version_count_related_issues()
JIRA.version_count_unresolved_issues()
JIRA.session()
JIRA.kill_session()
JIRA.kill_websudo()
JIRA.rename_user()
JIRA.delete_user()
JIRA.deactivate_user()
JIRA.reindex()
JIRA.backup()
JIRA.backup_progress()
JIRA.backup_complete()
JIRA.backup_download()
JIRA.current_user()
JIRA.delete_project()
JIRA.templates()
JIRA.permissionschemes()
JIRA.issue_type_schemes()
JIRA.issuesecurityschemes()
JIRA.projectcategories()
JIRA.avatars()
JIRA.notificationschemes()
JIRA.screens()
JIRA.workflowscheme()
JIRA.workflows()
JIRA.delete_screen()
JIRA.delete_permissionscheme()
JIRA.get_issue_type_scheme_associations()
JIRA.create_project()
JIRA.add_user()
JIRA.add_user_to_group()
JIRA.remove_user_from_group()
JIRA.role()
JIRA.get_igrid()
JIRA.boards()
JIRA.sprints()
JIRA.sprints_by_name()
JIRA.update_sprint()
JIRA.incompletedIssuesEstimateSum()
JIRA.removed_issues()
JIRA.removedIssuesEstimateSum()
JIRA.sprint_info()
JIRA.sprint()
JIRA.delete_board()
JIRA.create_board()
JIRA.create_sprint()
JIRA.add_issues_to_sprint()
JIRA.add_issues_to_epic()
JIRA.rank()
JIRA.move_to_backlog()
JIRA.pinned_comments()
JIRA.pin_comment()
- 6.1.2. jira.config module
- 6.1.3. jira.exceptions module
- 6.1.4. jira.jirashell module
- 6.1.5. jira.resilientsession module
- 6.1.6. jira.resources module
ResourceType
Resource
Issue
Comment
Project
Attachment
Component
Dashboard
DashboardItemProperty
DashboardItemPropertyKey
Filter
DashboardGadget
Votes
PermissionScheme
Watchers
Worklog
IssueLink
IssueLinkType
IssueProperty
IssueSecurityLevelScheme
IssueType
IssueTypeScheme
NotificationScheme
Priority
PriorityScheme
Version
WorkflowScheme
Role
Resolution
SecurityLevel
Status
User
Group
CustomFieldOption
RemoteLink
Customer
ServiceDesk
RequestType
PinnedComment
StatusCategory
AgileResource
Sprint
Board
Field
- 6.1.7. jira.utils module
- 6.1.1. jira.client module
- 6.1. jira package
This documents the jira
python package (version 3.9.1.dev1+gef10e1a), a Python library designed to ease the use of the
Jira REST API. Some basic support for the Jira Agile / Jira Software REST API also exists.
Documentation is also available in Dash format.
The source is stored at https://github.com/pycontribs/jira.
The release history and notes and can be found at https://github.com/pycontribs/jira/releases