Skip to content

Commit 56f3cf5

Browse files
author
Logan Gingerich
authored
Update README.md
1 parent 9c7f96e commit 56f3cf5

File tree

1 file changed

+12
-17
lines changed

1 file changed

+12
-17
lines changed

python-django-sso-example/README.md

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

88
## Django 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-django-example-applications.git
@@ -25,36 +20,36 @@ An example Django application demonstrating how to use the [WorkOS Python SDK](h
2520
$ git clone [email protected]:workos-inc/python-django-example-applications.git
2621
```
2722

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

3328

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

41-
5. Install the cloned app's dependencies. If the `pip` command doesn't work, try `pip3` instead.
36+
4. Install the cloned app's dependencies. If the `pip` command doesn't work, try `pip3` instead.
4237
```bash
4338
(env) $ pip install -r requirements.txt
4439
```
4540

46-
6. Obtain and make note of the following values. In the next step, these will be set as environment variables.
41+
5. Obtain and make note of the following values. In the next step, these will be set as environment variables.
4742
- Your [WorkOS API key](https://dashboard.workos.com/api-keys)
4843
- Your [SSO-specific, WorkOS Client ID](https://dashboard.workos.com/sso/configuration)
4944
- The redirect URI. For this example, we'll use http://localhost:8000/auth/callback
5045
51-
7. Ensure you're in the root directory for the example app, `python-django-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.)
46+
6. Ensure you're in the root directory for the example app, `python-django-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.)
5247
```bash
5348
(env) $ touch .env
5449
(env) $ nano .env
5550
```
5651
57-
8. Once the Nano text editor opens, you can directly edit the `.env` file by listing the environment variables:
52+
7. Once the Nano text editor opens, you can directly edit the `.env` file by listing the environment variables:
5853
```bash
5954
export WORKOS_API_KEY=<value found in step 6>
6055
export WORKOS_CLIENT_ID=<value found in step 6>
@@ -63,7 +58,7 @@ An example Django application demonstrating how to use the [WorkOS Python SDK](h
6358
6459
To exit the Nano text editor, type `CTRL + x`. When prompted to "Save modified buffer", type `Y`, then press the `Enter` or `Return` key.
6560
66-
9. Source the environment variables so they are accessible to the operating system.
61+
8. Source the environment variables so they are accessible to the operating system.
6762
```bash
6863
(env) $ source .env
6964
```
@@ -75,7 +70,7 @@ An example Django application demonstrating how to use the [WorkOS Python SDK](h
7570
(env) $ echo $REDIRECT_URI
7671
```
7772
78-
10. Run the Django migrations. Again, ensure you're in the `python-django-sso-example/` directory where the `manange.py` file is.
73+
9. Run the Django migrations. Again, ensure you're in the `python-django-sso-example/` directory where the `manange.py` file is.
7974
```bash
8075
(env) $ python3 manage.py migrate
8176
```
@@ -90,9 +85,9 @@ An example Django application demonstrating how to use the [WorkOS Python SDK](h
9085
. . .
9186
```
9287

93-
11. In `python-django-sso-example/sso/views.py` change the `CONNECTION_ID` string value to the connection ID that you are targeting. This can be found in the WorkOS Dashboard under the Connection Settings.
88+
10. In `python-django-sso-example/sso/views.py` change the `CONNECTION_ID` string value to the connection ID that you are targeting. This can be found in the WorkOS Dashboard under the Connection Settings.
9489

95-
12. The final setup step is to start the server.
90+
11. The final setup step is to start the server.
9691
```bash
9792
(env) $ python3 manage.py runserver --insecure
9893
```
@@ -125,7 +120,7 @@ If you get stuck, please reach out to us at [email protected] so we can help.
125120
126121
## Testing the Integration
127122
128-
13. Naviagte to the `python-django-sso-example` directory, which contains the `manage.py` file. Source the virtual environment we created earlier, if it isn't still activated from the steps above. Start the Django server locally.
123+
12. Naviagte to the `python-django-sso-example` directory, which contains the `manage.py` file. Source the virtual environment we created earlier, if it isn't still activated from the steps above. Start the Django server locally.
129124

130125
```bash
131126
$ cd ~/Desktop/python-django-sso-example/

0 commit comments

Comments
 (0)