--- description: Manage Capawesome Cloud from Python with the official SDK — apps, builds, channels, deployments, and more, fully typed with Pydantic models. title: Python SDK - Capawesome image: https://capawesome.io/docs/assets/images/social/cloud/sdks/python.png --- [Skip to content ](#python-sdk) [🔐 Introducing the **Capacitor Vault** plugin — store secrets behind biometrics or a device passcode. ](/blog/announcing-the-capacitor-vault-plugin/) * [ SDKs ](/docs/sdks/) * [ Formbricks ](/docs/sdks/capacitor/formbricks/) * [ Geocoder ](/docs/sdks/capacitor/geocoder/) * [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/) * [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/) * [ libSQL ](/docs/sdks/capacitor/libsql/) * [ Live Update ](/docs/sdks/capacitor/live-update/) * [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/) * [ Media Session ](/docs/sdks/capacitor/media-session/) * [ ML Kit ](/docs/sdks/capacitor/mlkit/) * [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/) * [ NFC ](/docs/sdks/capacitor/nfc/) * [ OAuth ](/docs/sdks/capacitor/oauth/) * [ Pedometer ](/docs/sdks/capacitor/pedometer/) * [ Photo Editor ](/docs/sdks/capacitor/photo-editor/) * [ PostHog ](/docs/sdks/capacitor/posthog/) * [ Printer ](/docs/sdks/capacitor/printer/) * [ Purchases ](/docs/sdks/capacitor/purchases/) * [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/) * [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/) * [ Screenshot ](/docs/sdks/capacitor/screenshot/) * [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/) * [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/) * [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/) * [ Share Target ](/docs/sdks/capacitor/share-target/) * [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/) * [ SQLite ](/docs/sdks/capacitor/sqlite/) * [ Superwall ](/docs/sdks/capacitor/superwall/) * [ Torch ](/docs/sdks/capacitor/torch/) * [ Vault ](/docs/sdks/capacitor/vault/) * [ Wifi ](/docs/sdks/capacitor/wifi/) * [ Zip ](/docs/sdks/capacitor/zip/) * [ Cordova ](/docs/sdks/cordova/) * [ Cloud ](/docs/cloud/) * [ Integrations ](/docs/cloud/live-updates/integrations/) * Concepts * Reference * [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/) * [ FAQ ](/docs/cloud/live-updates/faq/) * [ Native Builds ](/docs/cloud/native-builds/) * [ Set Up Environments ](/docs/cloud/native-builds/environments/) * [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/) * [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/) * [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/) * [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/) * [ Use pnpm, Yarn, or bun ](/docs/cloud/native-builds/package-managers/) * [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/) * [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/) * [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/) * [ Build without Git ](/docs/cloud/native-builds/build-without-git/) * [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/) * [ Integrations ](/docs/cloud/native-builds/integrations/) * Reference * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ FAQ ](/docs/cloud/native-builds/faq/) * [ App Store Publishing ](/docs/cloud/app-store-publishing/) * [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/) * [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/) * [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/) * [ FAQ ](/docs/cloud/app-store-publishing/faq/) * [ Automations ](/docs/cloud/automations/) * [ Reference ](/docs/cloud/automations/reference/) * [ Troubleshooting ](/docs/cloud/automations/troubleshooting/) * [ FAQ ](/docs/cloud/automations/faq/) * [ Assist ](/docs/cloud/assist/) * [ CLI ](/docs/cloud/cli/) * APIs and SDKs * [ Usage ](#usage) * [ Responses ](#responses) * [ Reference ](#reference) * [ Webhooks ](/docs/cloud/webhooks/) * [ Integrations ](/docs/cloud/integrations/) * Account * [ Organization ](/docs/cloud/organizations/) * [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/) * [ Audit Logs ](/docs/cloud/organizations/audit-logs/) * [ Billing ](/docs/cloud/organizations/billing/) * [ License Keys ](/docs/cloud/license-keys/) * [ AI ](/docs/ai/) * [ Insiders ](/docs/insiders/) * [ Billing & Plans ](/docs/insiders/billing-and-plans/) * [ FAQ ](/docs/insiders/faq/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/support/) * [ Contributing ](/docs/contributing/) * Contributing code * [ Code of Conduct ](/docs/contributing/code-of-conduct/) * [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion) * [ Blog ](/blog/) * Categories * [ Usage ](#usage) * [ Responses ](#responses) * [ Reference ](#reference) # Python SDK[¶](#python-sdk "Permanent link") The official Python SDK, [capawesome-cloud](https://pypi.org/project/capawesome-cloud/), gives you a fully typed, synchronous interface to the [Capawesome Cloud API](/docs/cloud/api/). Use it to manage apps, Live Update channels and deployments, native builds, app store destinations, and more from your own backend or tooling — anywhere the [CLI](/docs/cloud/cli/) isn't a fit. API in development The Capawesome Cloud API is still evolving and may change without notice. Response types intentionally expose only the most relevant properties to keep breaking changes to a minimum. ## Installation[¶](#installation "Permanent link") Install the package from PyPI. It requires **Python 3.9 or later**: `[](#%5F%5Fcodelineno-0-1)pip install capawesome-cloud ` ## Authentication[¶](#authentication "Permanent link") Create an [API token](/docs/cloud/accounts/tokens/) in the Console and pass it to the client, or set the `CAPAWESOME_CLOUD_TOKEN` environment variable (with `CAPAWESOME_TOKEN` accepted as a fallback): `[](#%5F%5Fcodelineno-1-1)from capawesome_cloud import CapawesomeCloud [](#%5F%5Fcodelineno-1-2) [](#%5F%5Fcodelineno-1-3)client = CapawesomeCloud(token="cap_...") ` The client holds a connection pool, so reuse a single instance. Use it as a context manager — or call `client.close()` — to release connections when you're done: `[](#%5F%5Fcodelineno-2-1)with CapawesomeCloud(token="cap_...") as client: [](#%5F%5Fcodelineno-2-2) for app in client.apps.list(): [](#%5F%5Fcodelineno-2-3) print(app.id, app.name) ` ### Configuration[¶](#configuration "Permanent link") The client accepts a few options beyond the token: | Option | Type | Default | Description | | ------------ | ------------ | -------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | | token | str | CAPAWESOME\_CLOUD\_TOKEN env var | API token used to authenticate. | | base\_url | str | https://api.cloud.capawesome.io | Base URL of the API. | | timeout | float | 30.0 | Request timeout in seconds. | | max\_retries | int | 2 | Retries with exponential backoff. 429 is always retried; network/5xx failures are retried only for idempotent methods. | | http\_client | httpx.Client | None | Bring your own pre-configured httpx.Client. | ## Usage[¶](#usage "Permanent link") Resources mirror the API's path hierarchy: app-scoped resources are nested under `client.apps.*` and take `app_id` as their first argument, while top-level resources such as `client.jobs` sit directly on the client. ### Trigger a build and wait for it[¶](#trigger-a-build-and-wait-for-it "Permanent link") A native build runs as a background **job**. Trigger it, then use the `wait()` helper to block until the job finishes: `[](#%5F%5Fcodelineno-3-1)build = client.apps.builds.create(app_id, platform="ios", git_ref="main") [](#%5F%5Fcodelineno-3-2) [](#%5F%5Fcodelineno-3-3)job = client.jobs.wait(build.job_id) [](#%5F%5Fcodelineno-3-4)print(job.status) ` ### Promote a build to a channel[¶](#promote-a-build-to-a-channel "Permanent link") Create a deployment to publish a build to a Live Update channel — optionally as a gradual rollout: `[](#%5F%5Fcodelineno-4-1)deployment = client.apps.deployments.create( [](#%5F%5Fcodelineno-4-2) app_id, [](#%5F%5Fcodelineno-4-3) app_build_id=app_build_id, [](#%5F%5Fcodelineno-4-4) app_channel_name="production", [](#%5F%5Fcodelineno-4-5) rollout_percentage=0.5, [](#%5F%5Fcodelineno-4-6)) ` ### Pagination[¶](#pagination "Permanent link") List methods return an iterator that lazily pages through **all** results. Iterate it directly, or collect everything with `to_list()`: `[](#%5F%5Fcodelineno-5-1)for device in client.apps.devices.list(app_id): [](#%5F%5Fcodelineno-5-2) print(device.id, device.app_version_name) [](#%5F%5Fcodelineno-5-3) [](#%5F%5Fcodelineno-5-4)channels = client.apps.channels.list(app_id).to_list() ` To fetch a single page with manual offset control, use `list_page()`: `[](#%5F%5Fcodelineno-6-1)page = client.apps.channels.list_page(app_id, limit=20, offset=0) ` ## Responses[¶](#responses "Permanent link") Responses are typed [Pydantic](https://docs.pydantic.dev) models, with app-scoped models prefixed `App` (`AppChannel`, `AppBuild`, …) to match the API's entity names. Only the most relevant fields are part of the public contract; any extra fields the API returns are still accessible via `model_dump()` but shouldn't be relied upon: `[](#%5F%5Fcodelineno-7-1)channel = client.apps.channels.get(app_id, channel_id) [](#%5F%5Fcodelineno-7-2)print(channel.name, channel.created_at) # documented fields [](#%5F%5Fcodelineno-7-3)print(channel.model_dump()) # full raw payload ` ## Reference[¶](#reference "Permanent link") The SDK covers the full API surface — apps, channels, deployments, builds and artifacts, certificates, environments, automations, devices, webhooks, and jobs. For the complete list of resources and options, see the [package on PyPI](https://pypi.org/project/capawesome-cloud/) and the [source on GitHub](https://github.com/capawesome-team/cloud-python), or browse the underlying [Cloud API](/docs/cloud/api/). June 8, 2026 Back to top