Skip to content

Commit 253e74c

Browse files
author
Logan Gingerich
authored
Update README.md
1 parent 0f7ebce commit 253e74c

File tree

1 file changed

+9
-14
lines changed

1 file changed

+9
-14
lines changed

python-flask-magic-link-example/README.md

Lines changed: 9 additions & 14 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,42 +20,42 @@ 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 Magic Link example app within the cloned repo.
23+
2. Navigate to the Magic Link example app within the cloned repo.
2924
```bash
3025
$ cd python-flask-example-applications/python-flask-magic-link-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
export WORKOS_API_KEY=<value found in step 6>
5853
export WORKOS_CLIENT_ID=<value found in step 6>
5954
```
6055

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

63-
9. Source the environment variables so they are accessible to the operating system.
58+
8. Source the environment variables so they are accessible to the operating system.
6459
```bash
6560
(env) $ source .env
6661
```
@@ -71,7 +66,7 @@ An example Flask application demonstrating how to use the [WorkOS Python SDK](ht
7166
(env) $ echo $WORKOS_CLIENT_ID
7267
```
7368

74-
10. The final setup step is to start the server.
69+
9. The final setup step is to start the server.
7570
```bash
7671
(env) $ flask run
7772
```

0 commit comments

Comments
 (0)