Skip to content

Commit 2a5b7ac

Browse files
author
Logan Gingerich
authored
Update README.md
1 parent 253e74c commit 2a5b7ac

File tree

1 file changed

+11
-16
lines changed

1 file changed

+11
-16
lines changed

python-flask-sso-example/README.md

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,7 @@ An example Flask application demonstrating how to use the [WorkOS Python SDK](ht
77

88
## Flask Project Setup
99

10-
1. In your CLI, navigate to the directory into which you want to clone this git repo.
11-
```bash
12-
$ cd ~/Desktop/
13-
```
14-
15-
2. Clone the main git repo for these Python example apps using your preferred secure method (HTTPS or SSH).
10+
1. Clone the main git repo for these Python example apps using your preferred secure method (HTTPS or SSH).
1611
```bash
1712
# HTTPS
1813
$ git clone https://github.com/workos-inc/python-flask-example-applications.git
@@ -25,34 +20,34 @@ An example Flask application demonstrating how to use the [WorkOS Python SDK](ht
2520
$ git clone [email protected]:workos-inc/python-flask-example-applications.git
2621
```
2722

28-
3. Navigate to the sso app within the cloned repo.
23+
2. Navigate to the sso app within the cloned repo.
2924
```bash
3025
$ cd python-flask-example-applications/python-flask-sso-example
3126
```
3227

33-
4. Create and source a Python virtual environment. You should then see `(env)` at the beginning of your command-line prompt.
28+
3. Create and source a Python virtual environment. You should then see `(env)` at the beginning of your command-line prompt.
3429
```bash
3530
$ python3 -m venv env
3631
$ source env/bin/activate
3732
(env) $
3833
```
3934

40-
5. Install the cloned app's dependencies.
35+
4. Install the cloned app's dependencies.
4136
```bash
4237
(env) $ pip install -r requirements.txt
4338
```
4439

45-
6. Obtain and make note of the following values. In the next step, these will be set as environment variables.
40+
5. Obtain and make note of the following values. In the next step, these will be set as environment variables.
4641
- Your [WorkOS API key](https://dashboard.workos.com/api-keys)
4742
- Your [SSO-specific, WorkOS Client ID](https://dashboard.workos.com/configuration)
4843

49-
7. Ensure you're in the root directory for the example app, `python-flask-sso-example/`. Create a `.env` file to securely store the environment variables. Open this file with the Nano text editor. (This file is listed in this repo's `.gitignore` file, so your sensitive information will not be checked into version control.)
44+
6. Ensure you're in the root directory for the example app, `python-flask-sso-example/`. Create a `.env` file to securely store the environment variables. Open this file with the Nano text editor. (This file is listed in this repo's `.gitignore` file, so your sensitive information will not be checked into version control.)
5045
```bash
5146
(env) $ touch .env
5247
(env) $ nano .env
5348
```
5449

55-
8. Once the Nano text editor opens, you can directly edit the `.env` file by listing the environment variables:
50+
7. Once the Nano text editor opens, you can directly edit the `.env` file by listing the environment variables:
5651
```bash
5752
WORKOS_API_KEY=<value found in step 6>
5853
WORKOS_CLIENT_ID=<value found in step 6>
@@ -61,7 +56,7 @@ An example Flask application demonstrating how to use the [WorkOS Python SDK](ht
6156

6257
To exit the Nano text editor, type `CTRL + x`. When prompted to "Save modified buffer", type `Y`, then press the `Enter` or `Return` key.
6358

64-
9. Source the environment variables so they are accessible to the operating system.
59+
8. Source the environment variables so they are accessible to the operating system.
6560
```bash
6661
(env) $ source .env
6762
```
@@ -72,9 +67,9 @@ An example Flask application demonstrating how to use the [WorkOS Python SDK](ht
7267
(env) $ echo $WORKOS_CLIENT_ID
7368
```
7469

75-
10. In `python-flask-sso-example/app.py` change the `CUSTOMER_CONNECTION_ID` string value to the connection you will be testing the login for. This can be found in your WorkOS Dashboard.
70+
9. In `python-flask-sso-example/app.py` change the `CUSTOMER_CONNECTION_ID` string value to the connection you will be testing the login for. This can be found in your WorkOS Dashboard.
7671

77-
11. The final setup step is to start the server.
72+
10. The final setup step is to start the server.
7873
```bash
7974
(env) $ flask run
8075
```
@@ -110,7 +105,7 @@ If you get stuck, please reach out to us at [email protected] so we can help.
110105

111106
## Testing the Integration
112107

113-
12. Naviagte to the `python-flask-sso-example` directory. Source the virtual environment we created earlier, if it isn't still activated from the steps above. Start the Flask server locally.
108+
11. Naviagte to the `python-flask-sso-example` directory. Source the virtual environment we created earlier, if it isn't still activated from the steps above. Start the Flask server locally.
114109

115110
```bash
116111
$ cd ~/Desktop/python-flask-sso-example/

0 commit comments

Comments
 (0)