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="your-email@example.com",
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
Metadata
Release files for sanhe-atlassian-sdk 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sanhe_atlassian_sdk-0.1.1.tar.gz | 8.0 kB | Without provenance | Details for sanhe_atlassian_sdk-0.1.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sanhe_atlassian_sdk-0.1.1-py3-none-any.whl | Python 3 | none | any | Details for sanhe_atlassian_sdk-0.1.1-py3-none-any.whl |
Total release size: 17.0 kB
Release files / sanhe_atlassian_sdk-0.1.1.tar.gz
| Download URL | sanhe_atlassian_sdk-0.1.1.tar.gz |
|---|---|
| Size | 8.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6df572e816044a0a95898b585c3d16f0db9c9e72a0ac37c421a4dd3fc859c4cb
|
|
BLAKE2b-256 checksum How to use checksums |
358f65309ad42fc22d81582800ad7b989d0f8a55200d5be2f4d6b19f15368b5a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.8
|
Release files / sanhe_atlassian_sdk-0.1.1-py3-none-any.whl
| Download URL | sanhe_atlassian_sdk-0.1.1-py3-none-any.whl |
|---|---|
| Size | 9.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
85a8a28bd1cdc49ab8b9621234b21e9f8d8399144206581d183fd4a1146687d1
|
|
BLAKE2b-256 checksum How to use checksums |
65f5cbe90194a762ba4724731c7b2efa97359bdda23137f14510fdb1f4787271
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.8
|
Security for sanhe-atlassian-sdk 0.1.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.