Skip to main content

WorkOS Python Client

Project description

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

workos-5.23.0.tar.gz (73.9 kB view details)

Uploaded Source

Built Distribution

workos-5.23.0-py3-none-any.whl (83.7 kB view details)

Uploaded Python 3

File details

Details for the file workos-5.23.0.tar.gz.

File metadata

  • Download URL: workos-5.23.0.tar.gz
  • Upload date:
  • Size: 73.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for workos-5.23.0.tar.gz
Algorithm Hash digest
SHA256 e144a77ac041f3ba873d7a9377f0cd82f1655af1b24f19c4ff313d0a8160ff5b
MD5 590063d49c2b3bb71efe3208430e50ad
BLAKE2b-256 1111905f5ea56930295705e9da1f2e028c6dc1a7509b8c6e7e1afbe8cdb940a1

See more details on using hashes here.

File details

Details for the file workos-5.23.0-py3-none-any.whl.

File metadata

  • Download URL: workos-5.23.0-py3-none-any.whl
  • Upload date:
  • Size: 83.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for workos-5.23.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a08236dd1e959eaa0e57c5f33415fb2e613970433cb21d17115a194a34b20e9e
MD5 c57c3ecccad12bfa1c60d7b1c01d2600
BLAKE2b-256 6e0e36af7ff893894716b8a8fd4b343c613ceb7b244fd627fa5001671bdd847e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page