# Python Jira

Python library to work with Jira APIs

- 1. Installation
  - 1.1. Dependencies
- 2. Examples
  - 2.1. Quickstart
    - 2.1.1. Initialization
    - 2.1.2. Authentication
      - 2.1.2.1. Cookie Based Authentication
      - 2.1.2.2. HTTP BASIC
        - 2.1.2.2.1. (username, password)
        - 2.1.2.2.2. (username, api_token)
      - 2.1.2.3. OAuth
      - 2.1.2.4. Kerberos
    - 2.1.3. Headers
    - 2.1.4. Issues
    - 2.1.5. Fields
    - 2.1.6. Searching
    - 2.1.7. Comments
    - 2.1.8. Transitions
    - 2.1.9. Projects
    - 2.1.10. Watchers
    - 2.1.11. Attachments
- 3. jirashell
- 4. Advanced
  - 4.1. Resource Objects and Properties
- 5. Contributing
  - 5.1. Discussion and support
  - 5.2. Contributing Code
  - 5.3. Testing
  - 5.4. Issues and Feature Requests
  - 5.5. Issues
  - 5.6. Pull Requests
- 6. API Documentation
  - 6.1. jira package
    - 6.1.1. jira.client module
    - 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
    - 6.1.7. jira.utils module

This documents the `jira` python package (version 3.1.1), a Python library designed to ease the use of the Jira REST API. Some basic support for the GreenHopper 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

## Indices and tables

- Index

- Module Index

- Search Page