sanhe-atlassian-sdk 0.1.1

Sanhe's Atlassian SDK for Python

---

Welcome to sanhe_atlassian_sdk Documentation

sanhe_atlassian_sdk is a lightweight foundational library for interacting with Atlassian REST APIs. It provides a unified HTTP client with both synchronous and asynchronous support, serving as the base layer for product-specific SDKs.

About

This library is designed as a low-level foundation that handles common concerns for Atlassian API interactions:

• Unified HTTP Client: Built on httpx for modern, high-performance HTTP operations

• Sync and Async Support: Seamlessly switch between synchronous and asynchronous request patterns based on your application needs

• Authentication: Built-in HTTP Basic Authentication for Atlassian Cloud APIs

• Pydantic Integration: Uses Pydantic for robust configuration validation

Product-Specific SDKs: This library serves as the foundation for higher-level SDKs that provide product-specific functionality:

• sanhe_confluence_sdk - Confluence Cloud API operations (coming soon)

• sanhe_jira_sdk - Jira Cloud API operations (coming soon)

Usage

from sanhe_atlassian_sdk import Atlassian

# Initialize the client
client = Atlassian(
    url="https://your-domain.atlassian.net",
    username="[e-mail]",
    password="your-api-token",  # Use API token, not your account password
)

# Use the synchronous client
response = client.sync_client.get(
    f"{client.url}/wiki/api/v2/spaces",
)

# Or use the asynchronous client
async def fetch_spaces():
    response = await client.async_client.get(
        f"{client.url}/wiki/api/v2/spaces",
    )
    return response.json()

Note: For Atlassian Cloud, you should use an API token as the password, not your account password.

Install

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

$ pip install sanhe-atlassian-sdk

To upgrade to latest version:

$ pip install --upgrade sanhe-atlassian-sdk