Skip to main content
Documentation Status https://github.com/MacHu-GWU/pyatlassian-project/actions/workflows/main.yml/badge.svg https://codecov.io/gh/MacHu-GWU/pyatlassian-project/branch/main/graph/badge.svg https://img.shields.io/pypi/v/pyatlassian.svg https://img.shields.io/pypi/l/pyatlassian.svg https://img.shields.io/pypi/pyversions/pyatlassian.svg https://img.shields.io/badge/Release_History!--None.svg?style=social https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
https://img.shields.io/badge/Link-Document-blue.svg https://img.shields.io/badge/Link-API-blue.svg https://img.shields.io/badge/Link-Install-blue.svg https://img.shields.io/badge/Link-GitHub-blue.svg https://img.shields.io/badge/Link-Submit_Issue-blue.svg https://img.shields.io/badge/Link-Request_Feature-blue.svg https://img.shields.io/badge/Link-Download-blue.svg

Welcome to pyatlassian Documentation

https://pyatlassian.readthedocs.io/en/latest/_static/pyatlassian-logo.png

pyatlassian provides a clean, intuitive, and fully-typed Python interface for interacting with Atlassian’s cloud services like Confluence and Jira. While other Python clients exist for Atlassian’s APIs, many are based on outdated APS specifications. PyAtlassian is built from the ground up to work seamlessly with the latest REST API versions.

Key Features

  • Modern Python Support: Built for modern Python with full type hints

  • Cloud-First Design: Optimized for Atlassian cloud services

  • REST API Focused: Direct interface with the latest Atlassian REST APIs

  • Products Supported:
    • Confluence Cloud

    • JIRA Cloud

    • More products coming soon…

Development Philosophy

While the initial vision for pyatlassian included automatic code generation from OpenAPI specifications, we chose a pragmatic approach focused on delivering immediate value. Here’s why:

  • Focus on Immediate Needs: Rather than waiting for a complete OpenAPI-based solution, we’re manually implementing the most critical API endpoints to provide a working solution sooner.

  • Quality Over Automation: Hand-crafted implementations allow us to provide a more Pythonic and intuitive interface, optimized for real-world usage patterns.

  • Parallel Development: While this project delivers immediate value through manual implementation, we maintain a separate project focused on OpenAPI-based generation for future scalability.

Install

pyatlassian is released on PyPI, so all you need is to:

$ pip install pyatlassian

To upgrade to latest version:

$ pip install --upgrade pyatlassian

Metadata

Release files for pyatlassian 0.3.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyatlassian 0.3.2
File Size Uploaded
pyatlassian-0.3.2.tar.gz 19.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pyatlassian 0.3.2
File Interpreter ABI Platform
pyatlassian-0.3.2-py3-none-any.whl Python 3 none any Details

Total release size: 46.3 kB

Release files / pyatlassian-0.3.2.tar.gz

Download URL pyatlassian-0.3.2.tar.gz
Size 19.5 kB
Tags Source
SHA-256 checksum
How to use checksums
7b618f9d587a2389f225d92f70d3479f0a61542d0088e966dab6f3ed1d2c669b
BLAKE2b-256 checksum
How to use checksums
9db15b74d9df346931690239ab2331514563a2f1984274942172eb50eb65d4bd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.11.8

Release files / pyatlassian-0.3.2-py3-none-any.whl

Download URL pyatlassian-0.3.2-py3-none-any.whl
Size 26.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e10878227f7a242b082064eec6a06958e52cf569cbce11ad4bd430a19f7175a8
BLAKE2b-256 checksum
How to use checksums
7f5af23c94d562dd7d74ded0164c986074de3b096baf23e018cae21a2dbe2ed4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.11.8

Release history Release notifications | RSS feed

This release

0.3.2 This release

2 release files

0.3.1

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.1.1

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page