Metadata-Version: 2.5
Name: burdenoff-workspaces-sdk
Version: 2026.1107.1
Summary: Official Python SDK for Burdenoff Workspaces — thin shell over burdenoff-sdk-libs
Project-URL: Homepage, https://github.com/algoshred/workspaces-sdk-python
Project-URL: Documentation, https://docs.burdenoff.com/developers/python-sdk
Project-URL: Repository, https://github.com/algoshred/workspaces-sdk-python
Project-URL: Issues, https://github.com/algoshred/workspaces-sdk-python/issues
Project-URL: Changelog, https://github.com/algoshred/workspaces-sdk-python/blob/main/CHANGELOG.md
Author-email: "Vignesh T.V" <vignesh@algoshred.com>
Maintainer-email: "Vignesh T.V" <vignesh@algoshred.com>
License: Proprietary License
        
        Copyright © 2025 Burdenoff Consultancy Services Pvt. Ltd.
        
        All rights reserved.
        
        This software and associated documentation files (the "Software") are the proprietary
        and confidential information of Burdenoff Consultancy Services Pvt. Ltd. ("Confidential Information").
        
        You shall not disclose such Confidential Information and shall use it only in accordance
        with the terms of the license agreement you entered into with Burdenoff Consultancy Services Pvt. Ltd..
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
        INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
        PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
        FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
        OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
        DEALINGS IN THE SOFTWARE.
        
        UNAUTHORIZED COPYING, MODIFICATION, DISTRIBUTION, OR USE OF THIS SOFTWARE, VIA ANY MEDIUM,
        IS STRICTLY PROHIBITED.
        
        For licensing inquiries, please contact:
        Burdenoff Consultancy Services Pvt. Ltd.
        Email: contact@burdenoff.com
        Website: https://burdenoff.com
License-File: LICENSE
Keywords: api-client,burdenoff,collaboration,graphql,python,sdk,workspaces
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Requires-Dist: burdenoff-sdk-libs>=2026.1107.1
Requires-Dist: httpx>=0.24.0
Requires-Dist: typing-extensions>=4.0.0; python_version < '3.11'
Provides-Extra: dev
Requires-Dist: black>=23.0.0; extra == 'dev'
Requires-Dist: flake8>=6.0.0; extra == 'dev'
Requires-Dist: isort>=5.12.0; extra == 'dev'
Requires-Dist: pre-commit>=3.0.0; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.21.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
Requires-Dist: pytest>=7.0.0; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx-autodoc-typehints>=1.19.0; extra == 'docs'
Requires-Dist: sphinx-rtd-theme>=1.2.0; extra == 'docs'
Requires-Dist: sphinx>=6.0.0; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest-asyncio>=0.21.0; extra == 'test'
Requires-Dist: pytest-cov>=4.0.0; extra == 'test'
Requires-Dist: pytest>=7.0.0; extra == 'test'
Requires-Dist: respx>=0.21.0; extra == 'test'
Description-Content-Type: text/markdown

# Burdenoff Workspaces SDK for Python

`burdenoff-workspaces-sdk` is the official async Python client for the
[Burdenoff Workspaces](https://burdenoff.com) platform API.

It is a thin shell over [`burdenoff-sdk-libs`](https://pypi.org/project/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

```bash
pip install burdenoff-workspaces-sdk
```

Python 3.10 or newer.

## Quick start

```python
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

```bash
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.
