Welcome to sanhe_confluence_sdk Documentation
sanhe_confluence_sdk is a Pythonic SDK for the Confluence REST API v2.
Features:
Everything is a Class: All requests and responses are represented as Python dataclasses with full type hints.
IDE Friendly: With complete type annotations, you get autocomplete and inline documentation in your IDE.
Access Raw Data: Every response object has a .raw_data attribute that gives you the original JSON dictionary if needed.
Consistent Pattern: All API calls follow the same pattern - create a Request, call .sync(client), get a Response.
Install
sanhe_confluence_sdk is released on PyPI, so all you need is to:
$ pip install sanhe-confluence-sdk
To upgrade to latest version:
$ pip install --upgrade sanhe-confluence-sdk
Quick Start
Create a Client:
from sanhe_confluence_sdk.api import Confluence
client = Confluence(
url="https://your-domain.atlassian.net",
username="your-email@example.com",
password="your-api-token", # https://id.atlassian.com/manage-profile/security/api-tokens
)
Basic Usage:
from sanhe_confluence_sdk.api import Confluence, m
client = Confluence(...)
# Create a request and execute it
request = m.GetSpacesRequest()
response = request.sync(client)
# Access typed results
for space in response.results:
print(f"Space: {space.name} (key={space.key})")
# Access raw JSON data
print(response.raw_data)
Pagination:
from sanhe_confluence_sdk.api import Confluence, paginate
from sanhe_confluence_sdk.methods.space.get_spaces import (
GetSpacesRequest,
GetSpacesResponse,
)
client = Confluence(...)
for response in paginate(
client=client,
request=GetSpacesRequest(),
response_type=GetSpacesResponse,
page_size=25,
max_items=100,
):
for space in response.results:
print(f"Space: {space.name}")
For more details, see the Full Documentation.
Metadata
Release files for sanhe-confluence-sdk 0.1.3
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_confluence_sdk-0.1.3.tar.gz | 25.0 kB | Without provenance | Details for sanhe_confluence_sdk-0.1.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sanhe_confluence_sdk-0.1.3-py3-none-any.whl | Python 3 | none | any | Details for sanhe_confluence_sdk-0.1.3-py3-none-any.whl |
Total release size: 72.1 kB
Release files / sanhe_confluence_sdk-0.1.3.tar.gz
| Download URL | sanhe_confluence_sdk-0.1.3.tar.gz |
|---|---|
| Size | 25.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c76c7c806455f9284c7735e33ae20024b4da5159811969943ce2f82b4d702538
|
|
BLAKE2b-256 checksum How to use checksums |
811f708da5b285d56b4aa30a2daef012be8b8bab1eff79ec1fcdc315fc91de0e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.11
|
Release files / sanhe_confluence_sdk-0.1.3-py3-none-any.whl
| Download URL | sanhe_confluence_sdk-0.1.3-py3-none-any.whl |
|---|---|
| Size | 47.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3ff3a54daf75cae82da997c54b1a3555112edc69af900c4fcac2774ff613e461
|
|
BLAKE2b-256 checksum How to use checksums |
8572dad752ec89fb6d2b7ac197e466a4ec244f186e5e9081ed11838a04a30556
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.11
|
Security for sanhe-confluence-sdk 0.1.3
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.