workos


Nameworkos JSON
Version 0.8.5 PyPI version JSON
download
home_pagehttps://github.com/workos-inc/workos-python
SummaryWorkOS Python Client
upload_time2021-02-23 17:52:04
maintainer
docs_urlNone
authorWorkOS
requires_python
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # workos-python

Python SDK to conveniently access the [WorkOS API](https://workos.com).

## 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
```

## Getting Started

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 utilizing SSO:
```python
import workos

workos.api_key = sk_abdsomecharactersm284
workos.client_id = client_b27needthisforssotemxo
```

For your convenience, a client is available as an entry point for accessing the WorkOS feature set:
```python
from workos import client

# URL to redirect a User to to initiate the WorkOS OAuth 2.0 workflow
client.sso.get_authorization_url(
    domain='customer-domain.com',
    redirect_uri='my-domain.com/auth/callback',
    state={
        'stuff': 'from_the_original_request',
        'more_things': 'ill_get_it_all_back_when_oauth_is_complete',
    }
)

# Get the WorkOSProfile for an authenticated User
client.get_profile(oauth_code)
```



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/workos-inc/workos-python",
    "name": "workos",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "",
    "author": "WorkOS",
    "author_email": "team@workos.com",
    "download_url": "https://files.pythonhosted.org/packages/8e/48/57cba3899fa6c3dc1fa773f53c500b92f033df11548dd6a0017a3c7956af/workos-0.8.5.tar.gz",
    "platform": "",
    "description": "# workos-python\n\nPython SDK to conveniently access the [WorkOS API](https://workos.com).\n\n## Installation\n\nTo install from PyPi, run the following:\n```\npip install workos\n```\n\nTo install from source, clone the repo and run the following:\n```\npython setup.py install\n```\n\n## Getting Started\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 utilizing SSO:\n```python\nimport workos\n\nworkos.api_key = sk_abdsomecharactersm284\nworkos.client_id = client_b27needthisforssotemxo\n```\n\nFor your convenience, a client is available as an entry point for accessing the WorkOS feature set:\n```python\nfrom workos import client\n\n# URL to redirect a User to to initiate the WorkOS OAuth 2.0 workflow\nclient.sso.get_authorization_url(\n    domain='customer-domain.com',\n    redirect_uri='my-domain.com/auth/callback',\n    state={\n        'stuff': 'from_the_original_request',\n        'more_things': 'ill_get_it_all_back_when_oauth_is_complete',\n    }\n)\n\n# Get the WorkOSProfile for an authenticated User\nclient.get_profile(oauth_code)\n```\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "WorkOS Python Client",
    "version": "0.8.5",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "85a7ecee132f52609be827a818476ad3",
                "sha256": "3aef13a694ef1521211a3b07d5f2ea3384404693ac8c464ac020ff6ea57e4b6f"
            },
            "downloads": -1,
            "filename": "workos-0.8.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "85a7ecee132f52609be827a818476ad3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 16355,
            "upload_time": "2021-02-23T17:52:02",
            "upload_time_iso_8601": "2021-02-23T17:52:02.667096Z",
            "url": "https://files.pythonhosted.org/packages/38/f3/8507832ccfe989246808763164696abf558d2c4793b00a490ff3b9d781f1/workos-0.8.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "2cb63ce6c7e26b1314e1a213cfd1119c",
                "sha256": "4accc665c12bac77b4dd3510411c306c46c2a39a15af403f7f03f6f85dfcecbd"
            },
            "downloads": -1,
            "filename": "workos-0.8.5.tar.gz",
            "has_sig": false,
            "md5_digest": "2cb63ce6c7e26b1314e1a213cfd1119c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 11522,
            "upload_time": "2021-02-23T17:52:04",
            "upload_time_iso_8601": "2021-02-23T17:52:04.096315Z",
            "url": "https://files.pythonhosted.org/packages/8e/48/57cba3899fa6c3dc1fa773f53c500b92f033df11548dd6a0017a3c7956af/workos-0.8.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-02-23 17:52:04",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "workos-inc",
    "error": "Could not fetch GitHub repository",
    "lcname": "workos"
}
        
Elapsed time: 0.20910s