https://github.com/workos/workos-python

Official Python SDK for interacting with the WorkOS API
https://github.com/workos/workos-python

adfs audit-logs azure-active-directory directory-sync gsuite-saml-apps python-sdk saml scim sso sso-authentication

Last synced: 3 months ago
JSON representation

Official Python SDK for interacting with the WorkOS API

• Host: GitHub
• URL: https://github.com/workos/workos-python
• Owner: workos
• License: mit
• Created: 2019-12-09T19:41:22.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2024-05-22T17:57:04.000Z (8 months ago)
• Last Synced: 2024-05-22T18:59:17.065Z (8 months ago)
• Topics: adfs, audit-logs, azure-active-directory, directory-sync, gsuite-saml-apps, python-sdk, saml, scim, sso, sso-authentication
• Language: Python
• Homepage: https://workos.com/docs/sdk/python
• Size: 755 KB
• Stars: 34
• Watchers: 19
• Forks: 10
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# WorkOS Python Library

![PyPI](https://img.shields.io/pypi/v/workos)

[![Build Status](https://workos.semaphoreci.com/badges/workos-python/branches/main.svg?style=shields&key=9e4cb5bb-86a4-4938-9ec2-fc9f9fc512be)](https://workos.semaphoreci.com/projects/workos-python)

The WorkOS library for Python provides convenient access to the WorkOS API from applications written in Python, [hosted on PyPi](https://pypi.org/project/workos/)

## Documentation

See the [API Reference](https://workos.com/docs/reference/client-libraries) 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](https://dashboard.workos.com/api-keys).

```python

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:

```python

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](https://semver.org/)) 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](#installation) 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

- [Single Sign-On Guide](https://workos.com/docs/sso/guide)

- [Directory Sync Guide](https://workos.com/docs/directory-sync/guide)

- [Admin Portal Guide](https://workos.com/docs/admin-portal/guide)

- [Magic Link Guide](https://workos.com/docs/magic-link/guide)