Metadata-Version: 2.1
Name: workos
Version: 0.8.6
Summary: WorkOS Python Client
Home-page: https://github.com/workos-inc/workos-python
Author: WorkOS
Author-email: team@workos.com
License: MIT
Description: # 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)
        ```
        
Platform: UNKNOWN
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Description-Content-Type: text/markdown
Provides-Extra: dev
