Add new django tutorial

.github/CODEOWNERS

@@ -54,6 +54,7 @@
 /profiler/**/*.py @kalyanac @GoogleCloudPlatform/python-samples-owners
 /pubsub/**/*.py @anguillanneuf @hongalex @GoogleCloudPlatform/python-samples-owners
 /run/**/*.py @averikitsch @grant @GoogleCloudPlatform/python-samples-owners
+/run/django/**/*.py @glasnt @GoogleCloudPlatform/python-samples-owners
 /scheduler/**/*.py @averikitsch @GoogleCloudPlatform/python-samples-owners
 /spanner/**/*.py @larkee @GoogleCloudPlatform/python-samples-owners
 /speech/**/*.py @telpirion @sirtorry @GoogleCloudPlatform/python-samples-owners

noxfile-template.py

@@ -17,6 +17,7 @@
 import os
 from pathlib import Path
 import sys
+from typing import Callable, Dict, List, Optional
 
 import nox
 
@@ -68,7 +69,7 @@
 TEST_CONFIG.update(TEST_CONFIG_OVERRIDE)
 
 
-def get_pytest_env_vars():
+def get_pytest_env_vars() -> Dict[str, str]:
  """Returns a dict for pytest invocation."""
  ret = {}
 
@@ -98,7 +99,7 @@ def get_pytest_env_vars():
 #
 
 
-def _determine_local_import_names(start_dir):
+def _determine_local_import_names(start_dir: str) -> List[str]:
  """Determines all import names that should be considered "local".
 
  This is used when running the linter to insure that import order is
@@ -136,7 +137,7 @@ def _determine_local_import_names(start_dir):
 
 
 @nox.session
-def lint(session):
+def lint(session: nox.sessions.Session) -> None:
  if not TEST_CONFIG['enforce_type_hints']:
  session.install("flake8", "flake8-import-order")
  else:
@@ -156,7 +157,7 @@ def lint(session):
 #
 
 @nox.session
-def blacken(session):
+def blacken(session: nox.sessions.Session) -> None:
  session.install("black")
  python_files = [path for path in os.listdir(".") if path.endswith(".py")]
 
@@ -171,7 +172,7 @@ def blacken(session):
 PYTEST_COMMON_ARGS = ["--junitxml=sponge_log.xml"]
 
 
-def _session_tests(session, post_install=None):
+def _session_tests(session: nox.sessions.Session, post_install: Callable = None) -> None:
  """Runs py.test for a particular project."""
  if os.path.exists("requirements.txt"):
  session.install("-r", "requirements.txt")
@@ -197,7 +198,7 @@ def _session_tests(session, post_install=None):
 
 
 @nox.session(python=ALL_VERSIONS)
-def py(session):
+def py(session: nox.sessions.Session) -> None:
  """Runs py.test for a sample using the specified version of Python."""
  if session.python in TESTED_VERSIONS:
  _session_tests(session)
@@ -212,9 +213,10 @@ def py(session):
 #
 
 
-def _get_repo_root():
+def _get_repo_root() -> Optional[str]:
  """ Returns the root folder of the project. """
- # Get root of this repository. Assume we don't have directories nested deeper than 10 items.
+ # Get root of this repository.
+ # Assume we don't have directories nested deeper than 10 items.
  p = Path(os.getcwd())
  for i in range(10):
  if p is None:
@@ -230,7 +232,7 @@ def _get_repo_root():
 
 @nox.session
 @nox.parametrize("path", GENERATED_READMES)
-def readmegen(session, path):
+def readmegen(session: nox.sessions.Session, path: str) -> None:
  """(Re-)generates the readme for a sample."""
  session.install("jinja2", "pyyaml")
  dir_ = os.path.dirname(path)

run/README.md

@@ -15,6 +15,7 @@ This directory contains samples for [Google Cloud Run](https://cloud.run). [Clou
 |[Cloud Pub/Sub][pubsub] | Handling Pub/Sub push messages | [<img src="https://storage.googleapis.com/cloudrun/button.svg" alt="Run on Google Cloud" height="30">][run_button_pubsub] |
 |[Cloud SQL (MySQL)][mysql] | Use MySQL with Cloud Run | - |
 |[Cloud SQL (Postgres)][postgres] | Use Postgres with Cloud Run | - |
+|[Django][django] | Deploy Django on Cloud Run | - |
 
 For more Cloud Run samples beyond Python, see the main list in the [Cloud Run Samples repository](https://github.com/GoogleCloudPlatform/cloud-run-samples).
 
@@ -109,6 +110,7 @@ for more information.
 [pubsub]: pubsub/
 [mysql]: ../cloud-sql/mysql/sqlalchemy
 [postgres]: ../cloud-sql/postgres/sqlalchemy
+[django]: django/
 [run_button_helloworld]: https://deploy.cloud.run/?git_repo=https://github.com/knative/docs&dir=docs/serving/samples/hello-world/helloworld-python
 [run_button_pubsub]: https://deploy.cloud.run/?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&dir=run/pubsub
 [testing]: https://cloud.google.com/run/docs/testing/local#running_locally_using_docker_with_access_to_services

run/django/.gcloudignore

@@ -0,0 +1 @@
+.env

run/django/Dockerfile

@@ -0,0 +1,36 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Use an official lightweight Python image.
+# https://hub.docker.com/_/python
+FROM python:3.8-slim
+
+ENV APP_HOME /app
+WORKDIR $APP_HOME
+
+# Removes output stream buffering, allowing for more efficient logging
+ENV PYTHONUNBUFFERED 1
+
+# Install dependencies
+COPY requirements.txt .
+RUN pip install --no-cache-dir -r requirements.txt 
+
+# Copy local code to the container image.
+COPY . .
+
+# Run the web service on container startup. Here we use the gunicorn
+# webserver, with one worker process and 8 threads.
+# For environments with multiple CPU cores, increase the number of workers
+# to be equal to the cores available.
+CMD exec gunicorn --bind 0.0.0.0:$PORT --workers 1 --threads 8 --timeout 0 mysite.wsgi:application

run/django/README.md

@@ -0,0 +1,15 @@
+# Getting started with Django on Cloud Run
+
+[![Open in Cloud Shell][shell_img]][shell_link]
+
+[shell_img]: http://gstatic.com/cloudssh/images/open-btn.png
+[shell_link]: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/GoogleCloudPlatform/python-docs-samples&page=editor&open_in_editor=run/django/README.md
+
+This repository is an example of how to run a [Django](https://www.djangoproject.com/) 
+app on Google Cloud Run (fully managed). 
+
+The Django application used in this tutorial is the [Writing your first Django app](https://docs.djangoproject.com/en/3.0/#first-steps), after completing [Part 1](https://docs.djangoproject.com/en/3.0/intro/tutorial01/) and [Part 2](https://docs.djangoproject.com/en/3.0/intro/tutorial02/).
+
+
+# Tutorial
+See our [Running Django on Cloud Run (fully managed)](https://cloud.google.com/python/django/run) tutorial for instructions for setting up and deploying this sample application.

run/django/cloudmigrate.yaml

@@ -0,0 +1,64 @@
+# Copyright 2020 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+steps:
+ - id: "build image"
+ name: "gcr.io/cloud-builders/docker"
+ args: ["build", "-t", "gcr.io/${PROJECT_ID}/${_SERVICE_NAME}", "."]
+
+ - id: "push image"
+ name: "gcr.io/cloud-builders/docker"
+ args: ["push", "gcr.io/${PROJECT_ID}/${_SERVICE_NAME}"]
+
+ - id: "apply migrations"
+ name: "gcr.io/google-appengine/exec-wrapper"
+ args:
+ [
+ "-i",
+ "gcr.io/$PROJECT_ID/${_SERVICE_NAME}",
+ "-s",
+ "${PROJECT_ID}:${_REGION}:${_INSTANCE_NAME}",
+ "-e",
+ "SETTINGS_NAME=${_SECRET_SETTINGS_NAME}",
+ "--",
+ "python",
+ "manage.py",
+ "migrate",
+ ]
+
+ - id: "collect static"
+ name: "gcr.io/google-appengine/exec-wrapper"
+ args:
+ [
+ "-i",
+ "gcr.io/$PROJECT_ID/${_SERVICE_NAME}",
+ "-s",
+ "${PROJECT_ID}:${_REGION}:${_INSTANCE_NAME}",
+ "-e",
+ "SETTINGS_NAME=${_SECRET_SETTINGS_NAME}",
+ "--",
+ "python",
+ "manage.py",
+ "collectstatic",
+ "--no-input",
+ ]
+
+substitutions:
+ _INSTANCE_NAME: django-instance
+ _REGION: us-central1
+ _SERVICE_NAME: polls-service
+ _SECRET_SETTINGS_NAME: django-settings
+
+images:
+ - "gcr.io/${PROJECT_ID}/${_SERVICE_NAME}"