# WorkOS Python Library
[](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](https://dashboard.workos.com/api-keys) at a minimum and [client id](https://dashboard.workos.com/sso/configuration) if you plan on using SSO:
```python
import workos
workos.api_key = "sk_1234"
workos.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)
Raw data
{
"_id": null,
"home_page": "https://github.com/workos-inc/workos-python",
"name": "workos",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "WorkOS",
"author_email": "team@workos.com",
"download_url": "https://files.pythonhosted.org/packages/40/f4/3624ed6935ffce49732cb3f29409ad31d63a1ec789978877ae7e84c2be19/workos-4.6.0.tar.gz",
"platform": null,
"description": "# WorkOS Python Library\n\n\n[](https://workos.semaphoreci.com/projects/workos-python)\n\nThe WorkOS library for Python provides convenient access to the WorkOS API from applications written in Python, [hosted on PyPi](https://pypi.org/project/workos/)\n\n## Documentation\n\nSee the [API Reference](https://workos.com/docs/reference/client-libraries) for Python usage examples.\n\n## Installation\n\nTo install from PyPi, run the following:\n\n```\npip install workos\n```\n\nTo install from source, clone the repo and run the following:\n\n```\npython setup.py install\n```\n\n## Configuration\n\nThe package will need to be configured with your [api key](https://dashboard.workos.com/api-keys) at a minimum and [client id](https://dashboard.workos.com/sso/configuration) if you plan on using SSO:\n\n```python\nimport workos\n\nworkos.api_key = \"sk_1234\"\nworkos.client_id = \"client_1234\"\n```\n\n## SDK Versioning\n\nFor 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.\n\n## Beta Releases\n\nWorkOS has features in Beta that can be accessed via Beta releases. We would love for you to try these\nand share feedback with us before these features reach general availability (GA). To install a Beta version,\nplease follow the [installation steps](#installation) above using the Beta release version.\n\n> Note: there can be breaking changes between Beta versions. Therefore, we recommend pinning the package version to a\n> specific version. This way you can install the same version each time without breaking changes unless you are\n> intentionally looking for the latest Beta version.\n\nWe highly recommend keeping an eye on when the Beta feature you are interested in goes from Beta to stable so that you\ncan move to using the stable version.\n\n## More Information\n\n- [Single Sign-On Guide](https://workos.com/docs/sso/guide)\n- [Directory Sync Guide](https://workos.com/docs/directory-sync/guide)\n- [Admin Portal Guide](https://workos.com/docs/admin-portal/guide)\n- [Magic Link Guide](https://workos.com/docs/magic-link/guide)\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "WorkOS Python Client",
"version": "4.6.0",
"project_urls": {
"Homepage": "https://github.com/workos-inc/workos-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a0eb5420a5c7a0d7c70834623024ff0e4d3f17358b1c712cbe880d93a6d61a9e",
"md5": "957fa0722b09e94920f09d1f6b07d499",
"sha256": "1e3c4f152b53764fa6f67123202a2187d0e71730676ef794d9919a356d107d2c"
},
"downloads": -1,
"filename": "workos-4.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "957fa0722b09e94920f09d1f6b07d499",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 36816,
"upload_time": "2024-05-03T20:17:55",
"upload_time_iso_8601": "2024-05-03T20:17:55.097718Z",
"url": "https://files.pythonhosted.org/packages/a0/eb/5420a5c7a0d7c70834623024ff0e4d3f17358b1c712cbe880d93a6d61a9e/workos-4.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "40f43624ed6935ffce49732cb3f29409ad31d63a1ec789978877ae7e84c2be19",
"md5": "aa48cfcce1448d6596a6a203f218150a",
"sha256": "1a68f90556ff1afecbb21aef9f5bfec801046da39212e5626dc36abfae222b60"
},
"downloads": -1,
"filename": "workos-4.6.0.tar.gz",
"has_sig": false,
"md5_digest": "aa48cfcce1448d6596a6a203f218150a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 25909,
"upload_time": "2024-05-03T20:17:56",
"upload_time_iso_8601": "2024-05-03T20:17:56.607302Z",
"url": "https://files.pythonhosted.org/packages/40/f4/3624ed6935ffce49732cb3f29409ad31d63a1ec789978877ae7e84c2be19/workos-4.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-03 20:17:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "workos-inc",
"github_project": "workos-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "workos"
}
JSON
