Atlassian API for Python

PyPI Documentation Code Coverage PyPI - Python Version Commit Check

Overview

atlassian-api-py is a small Python wrapper for Atlassian REST APIs. It provides ready-to-use clients for Jira, Bitbucket, and Confluence so you can automate common Atlassian tasks without rewriting endpoint and session handling code.

  • One script for Data Center and Cloud. Jira and Confluence clients detect Atlassian Cloud from the URL (*.atlassian.net) and switch to the Cloud endpoints where they differ: Jira’s /search/jql with nextPageToken paging, accountId instead of usernames, and the Confluence REST API v2. Method names and arguments stay the same; returned items are Cloud objects (for example a Confluence page has spaceId instead of space.key).

  • Jira Software boards, sprints and epics. List a board’s sprints, walk through the issues of a sprint, epic or backlog, and move issues between sprints, on Data Center and Cloud.

  • Installs next to atlassian-python-api. The import package is atlassian_api, so both libraries can live in the same environment.

  • One runtime dependency (requests) and inline type hints.

  • Bitbucket support targets Bitbucket Server/Data Center.

The clients are intentionally lightweight:

  • GET helpers return nested SimpleNamespace objects, so response fields can be accessed with dot notation.

  • POST, PUT, and DELETE helpers return decoded JSON dictionaries when the API returns JSON, or None for empty responses.

  • HTTP 4xx and 5xx responses raise APIError with the status code and response body.

Documentation: atlassian-api-py.readthedocs.io

Indices and tables

License

This project is released under the MIT License.