Merge pull request #111 from dodaromike/main

PythonDjango Sample

Author: jasonjoh

.github/ISSUE_TEMPLATE/bug_report.md

@@ -4,46 +4,33 @@ about: Create a report to help us improve
 title: ''
 labels: bug report, needs triage
 assignees: ''
----
-
-### Where did you get the code?
-
-- [ ] Downloaded from GitHub
-- [ ] Downloaded from the [Microsoft Graph quick start tool](https://developer.microsoft.com/graph/quick-start)
-- [ ] Followed the tutorial from [Microsoft Graph tutorials](https://docs.microsoft.com/graph/tutorials)
 
-### Describe the bug
+---
 
+**Describe the bug**
 A clear and concise description of what the bug is.
 
-### To Reproduce
-
+**To Reproduce**
 Steps to reproduce the behavior:
-
 1. Go to '...'
-1. Click on '....'
-1. Scroll down to '....'
-1. See error
-
-### Expected behavior
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
 
+**Expected behavior**
 A clear and concise description of what you expected to happen.
 
-### Screenshots
-
+**Screenshots**
 If applicable, add screenshots to help explain your problem.
 
-### Desktop
-
-- OS: [e.g. iOS]
-- Browser [e.g. chrome, safari]
-- Version [e.g. 22]
-
-### Dependency versions
-
-- Authentication library (MSAL, etc.) version:
-- Graph library (Graph SDK, REST library, etc.) version:
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
 
-### Additional context
+**Dependency versions**
+ - Authentication library (MSAL, etc.) version:
+ - Graph library (Graph SDK, REST library, etc.) version:
 
-Add any other context about the problem here.
+**Additional context**
+Add any other context about the problem here.

.github/workflows/django.yml

@@ -8,24 +8,24 @@ on:
 
 jobs:
   build:
-  
+
     defaults:
       run:
-        working-directory: demo/graph_tutorial
+        working-directory: graph_tutorial
 
     runs-on: ubuntu-latest
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.7, 3.8, 3.9]
+        python-version: ['3.8', '3.9', '3.10']
 
     steps:
     - uses: actions/checkout@v2
     - name: Copy settings file
       run: |
-        cp oauth_settings.yml.example oauth_settings.yml
+        cp oauth_settings.example.yml oauth_settings.yml
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install Dependencies

.gitignore

@@ -103,11 +103,5 @@ venv.bak/
 # mypy
 .mypy_cache/
 
-# VS Code
-.vscode/
-
 # OAuth settings
 oauth_settings.yml
-
-QSTemp/
-PythonDjangoQuickStart.zip

.vscode/settings.json

@@ -0,0 +1,16 @@
+{
+    "python.linting.pylintEnabled": true,
+    "python.linting.enabled": true,
+    "python.linting.pylintArgs": [
+        "--rcfile=graph_tutorial/.pylintrc"
+    ],
+    "cSpell.words": [
+        "calendarview",
+        "dateutil",
+        "gettz",
+        "newevent",
+        "signin",
+        "signout",
+        "timespec"
+    ]
+}

CONTRIBUTING.md

@@ -1,21 +1,79 @@
-# Microsoft Graph Training Module - Build Python Django apps with Microsoft Graph
+---
+page_type: sample
+description: This sample demonstrates how to use the Microsoft Graph to access data in Office 365 from a Python Django app.
+products:
+- ms-graph
+- microsoft-graph-calendar-api
+- office-exchange-online
+languages:
+- python
+---
+# Microsoft Graph sample Python web app
 
-This module will introduce you to working with Microsoft Graph to access data in Office 365 by building a Python Django web applications.
+This sample uses Microsoft Graph to access data in Office 365 by building a Python Django web application using the Azure AD v2 authentication endpoint.
 
-## Lab - Build Python Django apps with Microsoft Graph
+## Prerequisites
+- [Python](https://www.python.org/) (with [pip](https://pypi.org/project/pip/)) installed on your development machine. If you do not have Python, visit the previous link for download options. (**Note:** This tutorial was written with Python version 3.7.9 and Django version 3.2.15 The steps in this guide may work with other versions, but that has not been tested.)
+- Either a personal Microsoft account with a mailbox on Outlook.com, or a Microsoft work or school account.
 
-In this lab you will create a Python Django web application using the Azure AD v2 authentication endpoint to access data in Office 365 using Microsoft Graph.
+If you don't have a Microsoft account, there are a couple of options to get a free account:
 
-- [Python Microsoft Graph tutorial](https://docs.microsoft.com/graph/tutorials/python)
+- You can [sign up for a new personal Microsoft account](https://signup.live.com/signup?wa=wsignin1.0&rpsnv=12&ct=1454618383&rver=6.4.6456.0&wp=MBI_SSL_SHARED&wreply=https://mail.live.com/default.aspx&id=64855&cbcxt=mai&bk=1454618383&uiflavor=web&uaid=b213a65b4fdc484382b6622b3ecaa547&mkt=E-US&lc=1033&lic=1).
+- You can [sign up for the Microsoft 365 Developer Program](https://developer.microsoft.com/microsoft-365/dev-program) to get a free Office 365 subscription.
 
-## Completed sample
+## Register a web application with the Azure Active Directory admin center
 
-If you just want the completed sample generated by following this lab, you can find it here.
+1. Open a browser and navigate to the [Azure Active Directory admin center](https://aad.portal.azure.com). Login using a **personal account** (aka: Microsoft Account) or **Work or School Account**.
 
-- [Completed project](demo)
+1. Select **Azure Active Directory** in the left-hand navigation, then select **App registrations** under **Manage**.
 
-## Disclaimer
+1. Select **New registration**. On the **Register an application** page, set the values as follows.
+
+    - Set **Name** to `Python Graph Tutorial`.
+    - Set **Supported account types** to **Accounts in any organizational directory and personal Microsoft accounts**.
+    - Under **Redirect URI**, set the first drop-down to `Web` and set the value to `http://localhost:8000/callback`.
+
+1. Choose **Register**. On the **Python Graph Tutorial** page, copy the value of the **Application (client) ID** and save it, you will need it in the next step.
+
+1. Select **Certificates & secrets** under **Manage**. Select the **New client secret** button. Enter a value in **Description** and select one of the options for **Expires** and choose **Add**.
+
+1. Copy the client secret value before you leave this page. You will need it in the next step.
+
+    > [!IMPORTANT]
+    > This client secret is never shown again, so make sure you copy it now.
+
+## Configure the sample
+
+1. Rename the `oauth_settings.example.yml` file to `oauth_settings.yml`.
+1. Edit the `oauth_settings.yml` file and make the following changes.
+    1. Replace `YOUR_APP_ID_HERE` with the **Application Id** you got from the App Registration Portal.
+    1. Replace `YOUR_APP_PASSWORD_HERE` with the password you got from the App Registration Portal.
+1. In your command-line interface (CLI), navigate to this directory and run the following command to install requirements.
+
+    ```Shell
+    pip install -r requirements.txt
+    ```
 
-**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
+1. In your CLI, run the following command to initialize the app's database.
+
+    ```Shell
+    python manage.py migrate
+    ```
+
+## Run the sample
+
+1. Run the following command in your CLI to start the application.
+
+    ```Shell
+    python manage.py runserver
+    ```
+
+1. Open a browser and browse to `http://localhost:8000`.
+
+## Code of conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
+
+## Disclaimer
 
-This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). For more information, see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
+**THIS CODE IS PROVIDED _AS IS_ WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**