first commit

Author: Adam Wolfman

README.md

@@ -1,2 +1,16 @@
-# python-django-example-applications
-Example applications demonstrating the use of the WorkOS Python SDK to support SSO, Directory Sync, Admin Portal, and Magic Link.
+*# Python-Django Example Appplications powered by WorkOS
+*
+Example applications demonstrating to use the [WorkOS Python SDK](_https://github.com/workos-inc/workos-python_) for SSO, Directory Sync, Admin Portal and Magic Link.
+
+*## For more information, please see the following guides:
+*
+* [Single Sign-On](_https://workos.com/docs/sso/guide_)
+* [Directory Sync](_https://workos.com/docs/directory-sync/guide_)
+* [Admin Portal](_https://workos.com/docs/admin-portal/guide_)
+* [Magic Link](_https://workos.com/docs/magic-link/guide_)
+
+* [API Reference](_https://workos.com/docs/reference_)
+
+*## Need help?
+*
+If you get stuck and aren't able to resolve the issue by reading our [WorkOS Python SDK documentation](_https://docs.workos.com/sdk/python_) or [API reference](_https://workos.com/docs/reference_), you can reach out to us at [email protected] and we'll lend a hand!

python-django-admin-portal-example/.gitignore

@@ -0,0 +1,131 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+.DS_Store

python-django-admin-portal-example/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 erin-workos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

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

@@ -0,0 +1,131 @@
+# python-django-admin-portal-example
+A basic Django app that uses the [WorkOS Python SDK](https://github.com/workos-inc/workos-python) to access the Admin Portal.
+
+## Prerequisites
+- Python 3.6+
+
+
+### Clone Directory
+
+1. In your CLI, navigate to the directory into which you want to clone this git repo.
+   ```bash
+   $ cd ~/Desktop/
+   ```
+
+2. Clone the main git repo for these Python example apps using your preferred secure method (HTTPS or SSH).
+   ```bash
+   # HTTPS
+   $ git clone https://github.com/workos-inc/python-django-example-applications.git
+   ```
+
+   or
+
+   ```bash
+   # SSH
+   $ git clone [email protected]:workos-inc/python-django-example-applications.git
+   ```
+
+3. Navigate to the Admin Portal example app within the cloned repo.
+   ```bash
+   $ cd python-django-example-applications/python-django-admin-portal-example
+   ````
+
+### Install Dependencies
+
+4. Create and source a Python virtual environment. You should then see `(env)` at the beginning of your command-line prompt.
+   ```bash
+   $ python3 -m venv env
+   $ source env/bin/activate
+   (env) $
+   ```
+
+5. Move in to the app directory and install the cloned app's dependencies. There are two workos_django directories in this repo, however you'll want to be in the top level directory that includes the manage.py file for this step. 
+   ```bash
+   (env) $ cd workos_django
+   (env) $ pip install -r requirements.txt
+   ```
+
+### Set Environment Variables
+
+6. Obtain and make note of the following values. In the next step, these will be set as environment variables.
+   - Your [WORKOS_API_KEY](https://dashboard.workos.com/api-keys)
+   - Your `WORKOS_CLIENT_ID`, in the format `client_<random-alphanumeric-string>`, retrievable from WorkOS dashboard under Configuration.
+
+7. Ensure you're in the root app directory for the example app, `workos_django/` where the `manage.py` file resides. 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.)
+   ```bash
+   (env) $ touch .env
+   (env) $ nano .env
+   ```
+
+8. Once the Nano text editor opens, you can directly edit the `.env` file by listing the environment variables:
+      ```bash
+    export WORKOS_API_KEY=<value found in step 6>
+    export WORKOS_CLIENT_ID=<value found in step 6>
+    ```
+
+    To exit the Nano text editor, type `CTRL + x`. When prompted to "Save modified buffer", type `Y`, then press the `Enter` or `Return` key.
+
+9. Source the environment variables so they are accessible to the operating system.
+   ```bash
+   (env) $ source .env
+   ```
+
+   You can ensure the environment variables were set correctly by running the following commands. The output should match the corresponding values.
+   ```bash
+   (env) $ echo $WORKOS_API_KEY
+   (env) $ echo $WORKOS_CLIENT_ID
+   ```
+
+10. Run the Django migrations. Again, ensure you're in the `workos_django/` directory where the `manange.py` file is.
+  ```bash
+  (env) $ python3 manage.py migrate
+  ```
+
+  You should see output like:
+  ```bash
+  Operations to perform:
+  Apply all migrations: admin, auth, contenttypes, sessions
+  Running migrations:
+  Applying contenttypes.0001_initial... OK
+  Applying auth.0001_initial... OK
+  . . .
+  ```
+
+11. Update the Admin Portal Redirect Link in the Configuration page of your WorkOS Dashboard
+
+   To configure the page where the user will be redirected after completing the organization creation/connection through Admin Portal, enter the url in the Admin Portal Redirect Link in the Configuration page of your WorkOS dashboard. This URL must be https. 
+
+
+## Start the server
+
+12. Start the server.
+  
+  To serve static files in development while still having `debug=True` in settings.py to able to send requests to WorkOS, be sure to include the `--insecure` flag when starting the server locally.
+  ```bash
+  (env) $ python3 manage.py runserver --insecure
+  ```
+
+  You'll know the server is running when you see no errors in the CLI, and output similar to the following is displayed:
+
+  ```bash
+  Watching for file changes with StatReloader
+  Performing system checks...
+
+  System check identified no issues (0 silenced).
+  March 18, 2021 - 04:54:50
+  Django version 3.1.7, using settings 'workos_django.settings'
+  Starting development server at http://127.0.0.1:8000/
+  Quit the server with CONTROL-C.
+  ```
+
+13. Once the server is running, navigate to http://localhost:8000 to view the home page of the app. Here you'll enter the name of the Organization to be created, and all associated domains. The domains should be entered as space-separated values, e.g. `domain1.com domain2.com domain3.com`
+
+Note that the organization must be a new organization that does not yet exists in your WorkOS dashboard. 
+
+14. Click on the button to create your Organization and log in to the Admin Portal workflow! 
+
+## Need help?
+
+When you clone this repo, the `DEBUG` setting is `False` by default in `app.py`. You can set `DEBUG = True` if you need to troubleshoot something during the tutorial, but you must use `DEBUG = False` in order to successfully connect to the WorkOS API.
+
+If you get stuck and aren't able to resolve the issue by reading our API reference or tutorials, please  reach out to us at [email protected] and we'll help you out.

python-django-admin-portal-example/workos_django/admin_portal/__init__.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

python-django-admin-portal-example/workos_django/admin_portal/admin.py

@@ -0,0 +1,6 @@
+from django.apps import AppConfig
+
+
+class AdminPortalConfig(AppConfig):
+    default_auto_field = 'django.db.models.BigAutoField'
+    name = 'admin_portal'

python-django-admin-portal-example/workos_django/admin_portal/apps.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.