Skip to content

Commit b01235b

Browse files
author
Logan Gingerich
authored
README update for SDK consistency (#63)
1 parent cb41720 commit b01235b

File tree

1 file changed

+16
-22
lines changed

1 file changed

+16
-22
lines changed

README.md

Lines changed: 16 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
# workos-python
1+
# WorkOS Python Library
22

3-
Python SDK to conveniently access the [WorkOS API](https://workos.com/docs/reference), [hosted on PyPi](https://pypi.org/project/workos/).
3+
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/)
4+
5+
## Documentation
6+
7+
See the [API Reference](https://workos.com/docs/reference/client-libraries) for Python usage examples.
48

59
## Installation
610

@@ -14,30 +18,20 @@ To install from source, clone the repo and run the following:
1418
python setup.py install
1519
```
1620

17-
## Getting Started
21+
## Configuration
1822

1923
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:
24+
2025
```python
2126
import workos
2227

23-
workos.api_key = "sk_abdsomecharactersm284"
24-
workos.client_id = "client_b27needthisforssotemxo"
28+
workos.api_key = "sk_1234"
29+
workos.client_id = "client_1234"
2530
```
2631

27-
A client is available as an entry point to the WorkOS feature set:
28-
```python
29-
from workos import client
30-
31-
# URL to redirect a User so they can initiate the WorkOS OAuth 2.0 workflow
32-
client.sso.get_authorization_url(
33-
domain='customer-domain.com',
34-
redirect_uri='my-domain.com/auth/callback',
35-
state={
36-
'stuff': 'from_the_original_request',
37-
'more_things': 'ill_get_it_all_back_when_oauth_is_complete',
38-
}
39-
)
40-
41-
# Get the WorkOSProfile for an authenticated User
42-
client.get_profile(oauth_code)
43-
```
32+
## More Information
33+
34+
* [Single Sign-On Guide](https://workos.com/docs/sso/guide)
35+
* [Directory Sync Guide](https://workos.com/docs/directory-sync/guide)
36+
* [Admin Portal Guide](https://workos.com/docs/admin-portal/guide)
37+
* [Magic Link Guide](https://workos.com/docs/magic-link/guide)

0 commit comments

Comments
 (0)