Burdenoff Workspaces SDK for Python
burdenoff-workspaces-sdk is the official async Python client for the
Burdenoff Workspaces platform API.
It is a thin shell over burdenoff-sdk-libs:
every GraphQL operation lives in a shared sdk-libs module, so this SDK, the
Workspaces CLI and the other Burdenoff product SDKs send the same documents.
This package picks the modules the Workspaces product exposes, points them at
the production gateways and gives you one typed client.
Install
pip install burdenoff-workspaces-sdk
Python 3.10 or newer.
Quick start
import asyncio
import os
from burdenoff_sdk_libs.modules.auth.types import SignInInput
from workspaces_sdk import WorkspacesSDK
async def main() -> None:
sdk = WorkspacesSDK() # production endpoints by default
try:
await sdk.auth.sign_in(
SignInInput(
username=os.environ["WORKSPACES_EMAIL"],
password=os.environ["WORKSPACES_PASSWORD"],
)
)
me = await sdk.auth.get_current_user()
print("Signed in as", me.email)
workspaces = await sdk.workspaces.list()
for workspace in workspaces.items:
print(workspace.id, workspace.name)
finally:
await sdk.close()
asyncio.run(main())
Other ways to authenticate:
sdk.auth.login_with_api_key(key)for an API key.sdk.auth.login_with_client_credentials(client_id, client_secret)for an app.sdk.auth.login_with_device_code()for the OAuth2 device-code flow.- Pass
access_token=/refresh_token=to the constructor to reuse tokens.
Workspace-scoped calls use the token you get from
sdk.auth.issue_workspace_token(workspace_id, organization_id).
Modules
| Attribute | What it covers |
|---|---|
auth |
Sign in/up, OAuth device code and PKCE, API keys, current user, workspace tokens |
workspaces |
Workspaces, members, projects, invites, activity log |
organizations |
Organizations, members, invites |
tags |
Universal tags and tag analytics |
groups |
Groups, members, hierarchy |
conversations |
Conversations, messages, threads, reactions |
files |
Files, folders, sharing |
notifications |
Notification inbox and preferences |
rbac |
Roles, policies, permission checks |
integrations |
Integration providers and connections |
security |
Vaults and secrets |
export |
Export jobs and templates |
products |
Products, shortcuts, content pages, feature flags |
store |
Marketplace search, cart, orders, installed apps |
support |
Support tickets and knowledge base |
tours |
Product tours and progress |
health |
Gateway health checks |
Billing, channels, developer portal, sandbox and scheduler are not mounted yet: some of their sdk-libs operations do not match the production schema. They will be added once sdk-libs repairs them.
Endpoints
Defaults are the production gateways. Override them per client or by environment variable:
| Precedence | Workspace gateway | Global gateway |
|---|---|---|
| Constructor | workspace_endpoint= |
global_endpoint= |
| Product env | WORKSPACES_WORKSPACE_ENDPOINT |
WORKSPACES_GLOBAL_ENDPOINT |
| Generic env | BURDENOFF_WORKSPACE_ENDPOINT |
BURDENOFF_GLOBAL_ENDPOINT |
| Default | https://graphqlworkspaces.burdenoff.com/workspaces/graphql |
https://graphql.burdenoff.com/global/graphql |
Development
uv sync --all-extras
uv run pytest # unit tests, mocked transport, no network
uv run flake8 src/
Releasing
Releases are CalVer (YYYY.MDD.PATCH) and run through
.github/workflows/release.yml, the shared algoshred/dev release-pypi
workflow. Push a CalVer tag on a commit that is on main, or dispatch the
workflow with an empty version to take today's next free patch. The version
is stamped at build time and never committed back. Guide:
dev/platform/context/delivery/cicd/HOW_TO_RELEASE_CLIENT_PACKAGES.md.
Documentation
https://docs.burdenoff.com/developers/python-sdk
License
Proprietary. Copyright Burdenoff Consultancy Services Pvt. Ltd.
Metadata
Release files for burdenoff-workspaces-sdk 2026.1031.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 |
|---|---|---|---|---|
| burdenoff_workspaces_sdk-2026.1031.1.tar.gz | 13.7 kB | Without provenance | Details for burdenoff_workspaces_sdk-2026.1031.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| burdenoff_workspaces_sdk-2026.1031.1-py3-none-any.whl | Python 3 | none | any | Details for burdenoff_workspaces_sdk-2026.1031.1-py3-none-any.whl |
Total release size: 22.5 kB
Release files / burdenoff_workspaces_sdk-2026.1031.1.tar.gz
| Download URL | burdenoff_workspaces_sdk-2026.1031.1.tar.gz |
|---|---|
| Size | 13.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a046e8fe319f15d94630d17b6f6f3d43669b916f70be9a03468bd978cf803bc4
|
|
BLAKE2b-256 checksum How to use checksums |
7a6da2de093823bb6840babaeea8cf3d36f1b7f3b9ce25221bbde456b81c79ca
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / burdenoff_workspaces_sdk-2026.1031.1-py3-none-any.whl
| Download URL | burdenoff_workspaces_sdk-2026.1031.1-py3-none-any.whl |
|---|---|
| Size | 8.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e7eba82767e396167b956584e6ef6d8a5afb90922c8bf7a63799c65dab7e5d82
|
|
BLAKE2b-256 checksum How to use checksums |
eb05d81b601163ed95aed7f7d00f194c47306a10225dab27d71f94330ac5708a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Security for burdenoff-workspaces-sdk 2026.1031.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.