WorkOS Python Library
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.35.0
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 |
|---|---|---|---|---|
| workos-5.35.0.tar.gz | 85.9 kB | Without provenance | Details for workos-5.35.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| workos-5.35.0-py3-none-any.whl | Python 3 | none | any | Details for workos-5.35.0-py3-none-any.whl |
Total release size: 180.3 kB
Release files / workos-5.35.0.tar.gz
| Download URL | workos-5.35.0.tar.gz |
|---|---|
| Size | 85.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
72b9de4abba5b22d8d199f3d6b2d0f8f02a7bca810056e1bdb26b384b2b134a6
|
|
BLAKE2b-256 checksum How to use checksums |
3ae488ea06df073a0eb302b5f2a0a0f90feefe8995d21389dbd8dd319301b769
|
| 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.35.0-py3-none-any.whl
| Download URL | workos-5.35.0-py3-none-any.whl |
|---|---|
| Size | 94.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
50c2a497e711d90423d0ccb3516063473148ff90cf3b2ef1b7db308b3bbbf4f3
|
|
BLAKE2b-256 checksum How to use checksums |
fdffa85a7971389a721b9890494bfee4d848a3746680d1b6f711c7a056094ea1
|
| 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.35.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.