workos 1.24.0

WorkOS Python Client

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 at a minimum and client id if you plan on using SSO:

import workos

workos.api_key = "sk_1234"
workos.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.

More Information

• Single Sign-On Guide
• Directory Sync Guide
• Admin Portal Guide
• Magic Link Guide