Skip to main content

WorkOS Python Library

PyPI Build Status

The WorkOS library for Python provides convenient access to the WorkOS API from applications written in Python, hosted on PyPi

Documentation

See the API Reference for Python usage examples.

Installation

To install from PyPi, run the following:

pip install workos

To install from source, clone the repo and run the following:

python setup.py install

Configuration

The package will need to be configured with your api key and client ID.

from workos import WorkOSClient

workos_client = WorkOSClient(
    api_key="sk_1234", client_id="client_1234"
)

The SDK also provides asyncio support for some SDK methods, via the async client:

from workos import AsyncWorkOSClient

async_workos_client = AsyncWorkOSClient(
    api_key="sk_1234", client_id="client_1234"
)

SDK Versioning

For our SDKs WorkOS follows a Semantic Versioning (SemVer) process where all releases will have a version X.Y.Z (like 1.0.0) pattern wherein Z would be a bug fix (e.g., 1.0.1), Y would be a minor release (1.1.0) and X would be a major release (2.0.0). We permit any breaking changes to only be released in major versions and strongly recommend reading changelogs before making any major version upgrades.

Beta Releases

WorkOS has features in Beta that can be accessed via Beta releases. We would love for you to try these and share feedback with us before these features reach general availability (GA). To install a Beta version, please follow the installation steps above using the Beta release version.

Note: there can be breaking changes between Beta versions. Therefore, we recommend pinning the package version to a specific version. This way you can install the same version each time without breaking changes unless you are intentionally looking for the latest Beta version.

We highly recommend keeping an eye on when the Beta feature you are interested in goes from Beta to stable so that you can move to using the stable version.

More Information

Metadata

Release files for workos 5.28.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for workos 5.28.0
File Size Uploaded Provenance Actions
workos-5.28.0.tar.gz 82.3 kB Without provenance Details for workos-5.28.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for workos 5.28.0
File Interpreter ABI Platform Actions
workos-5.28.0-py3-none-any.whl Python 3 none any Details for workos-5.28.0-py3-none-any.whl

Total release size: 173.1 kB

Release files / workos-5.28.0.tar.gz

Download URL workos-5.28.0.tar.gz
Size 82.3 kB
Tags Source
SHA-256 checksum
How to use checksums
077db1c1fb22463552e2da7510f69cdca9ddb717922414f3bd071ac7e9f31b6a
BLAKE2b-256 checksum
How to use checksums
889bbeb07cef05fcf332ffcb14115739c1b032095a43293c0e85a8d80a49cc34
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.3

Release files / workos-5.28.0-py3-none-any.whl

Download URL workos-5.28.0-py3-none-any.whl
Size 90.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
fd5ae11682759bd0fd6f7b709b944504a697429c42d89fa4b7570dd1b3147cfa
BLAKE2b-256 checksum
How to use checksums
99f0b75378ff9d50e282d6205d115f15f5b0849bff461aa533793130679519a2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.3

Security for workos 5.28.0

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.

Release history Release notifications | RSS feed

This release

5.28.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page