Skip to content

Commit f8177d6

Browse files
author
Logan Gingerich
authored
Update README.md
1 parent d575150 commit f8177d6

File tree

1 file changed

+10
-15
lines changed

1 file changed

+10
-15
lines changed

python-flask-admin-portal-example/README.md

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

77
## Flask Project Setup
88

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

27-
3. Navigate to the Admin Portal example app within the cloned repo.
22+
2. Navigate to the Admin Portal example app within the cloned repo.
2823
```bash
2924
$ cd python-flask-example-applications/python-flask-admin-portal-example
3025
````
3126

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

39-
5. Install the cloned app's dependencies.
34+
4. Install the cloned app's dependencies.
4035
```bash
4136
(env) $ pip install -r requirements.txt
4237
```
4338
44-
6. Obtain and make note of the following values. In the next step, these will be set as environment variables.
39+
5. Obtain and make note of the following values. In the next step, these will be set as environment variables.
4540
- Your [WorkOS API key](https://dashboard.workos.com/api-keys)
4641
- Your `WORKOS_CLIENT_ID`, in the format `client_<random-alphanumeric-string>`, retrievable from WorkOS dashboard under "Configuration".
4742
48-
7. Ensure you're in the root directory for the example app, `python-flask-admin-portal-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.)
43+
6. Ensure you're in the root directory for the example app, `python-flask-admin-portal-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.)
4944
```bash
5045
(env) $ touch .env
5146
(env) $ nano .env
5247
```
5348
54-
8. Once the Nano text editor opens, you can directly edit the `.env` file by listing the environment variables:
49+
7. Once the Nano text editor opens, you can directly edit the `.env` file by listing the environment variables:
5550
```bash
5651
export WORKOS_API_KEY=<value found in step 6>
5752
export WORKOS_CLIENT_ID=<value found in step 6>
5853
```
5954
6055
To exit the Nano text editor, type `CTRL + x`. When prompted to "Save modified buffer", type `Y`, then press the `Enter` or `Return` key.
6156
62-
9. Source the environment variables so they are accessible to the operating system.
57+
8. Source the environment variables so they are accessible to the operating system.
6358
```bash
6459
(env) $ source .env
6560
```
@@ -70,13 +65,13 @@ An example Flask application demonstrating how to use the [WorkOS Python SDK](ht
7065
(env) $ echo $WORKOS_CLIENT_ID
7166
```
7267
73-
10. Update the Admin Portal Redirect Link in the "Configuration" page of your WorkOS Dashboard. The URL should be http://localhost:5000. If you are using Mac OS Monterey, set this to localhost:5001.
68+
9. Update the Admin Portal Redirect Link in the "Configuration" page of your WorkOS Dashboard. The URL should be http://localhost:5000. If you are using Mac OS Monterey, set this to localhost:5001.
7469
7570
After an Admin Portal user creates an SSO connection using the Admin Portal, they need to be redirected to a webpage within your application (usually this webpage confirms successful creation of the connection). To configure which webpage this is, enter the webpage’s URL in the Configuration section of your WorkOS dashboard under the “Admin Portal Redirect Link” header. For production usage this URL must begin with HTTPS, but for development purposes the URL can begin with HTTP.
7671
7772
## Start the server
7873
79-
11. The final setup step is to start the server.
74+
10. The final setup step is to start the server.
8075
```bash
8176
(env) $ flask run
8277
```

0 commit comments

Comments
 (0)