Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Azure-Samples/msdocs-django-postgresql-sample-app

A sample Django app using PostgreSQL for the Azure App Service Web App + Database tutorial
https://github.com/Azure-Samples/msdocs-django-postgresql-sample-app

azd-templates azure django postgresql python

Last synced: 16 days ago
JSON representation

A sample Django app using PostgreSQL for the Azure App Service Web App + Database tutorial

Awesome Lists containing this project

README 

        
---

page_type: sample

languages:

- azdeveloper

- python

- bicep

- html

products:

- azure

- azure-app-service

- azure-database-postgresql

- azure-virtual-network

urlFragment: msdocs-django-postgresql-sample-app

name: Deploy a Python (Django) web app with PostgreSQL in Azure

description: This is a Python web app using the Django framework and the Azure Database for PostgreSQL relational database service. 

---



# Deploy a Python (Django) web app with PostgreSQL in Azure



This is a Python web app using the Django framework and the Azure Database for PostgreSQL relational database service. The Django app is hosted in a fully managed Azure App Service. This app is designed to be be run locally and then deployed to Azure. You can either deploy this project by following the tutorial [*Deploy a Python (Django or Flask) web app with PostgreSQL in Azure*](https://docs.microsoft.com/azure/app-service/tutorial-python-postgresql-app) or by using the [Azure Developer CLI (azd)](https://learn.microsoft.com/azure/developer/azure-developer-cli/overview) according to the instructions below.



Additionally, the sample application demonstrates Azure Redis Cache access by caching the restaurant details page for 60 seconds. You can add the Azure Redis Cache integration in the [secure-by-default web app + database creation wizard](https://portal.azure.com/?feature.customportal=false#create/Microsoft.AppServiceWebAppDatabaseV3), and it's also included in the [AZD template](https://github.com/Azure-Samples/python-app-service-postgresql-infra).



## Requirements



The [requirements.txt](./requirements.txt) has the following packages, all used by a typical data-driven Django application:



| Package | Description |

| ------- | ----------- |

| [Django](https://pypi.org/project/Django/) | Web application framework. |

| [pyscopg2-binary](https://pypi.org/project/psycopg-binary/) | PostgreSQL database adapter for Python. |

| [python-dotenv](https://pypi.org/project/python-dotenv/) | Read key-value pairs from .env file and set them as environment variables. In this sample app, those variables describe how to connect to the database locally. 

 This package is used in the [manage.py](./manage.py) file to load environment variables. |

| [whitenoise](https://pypi.org/project/whitenoise/) | Static file serving for WSGI applications, used in the deployed app. 

 This package is used in the [azureproject/production.py](./azureproject/production.py) file, which configures production settings. |

| [django-redis](https://pypi.org/project/django-redis/) | Redis cache backend for Django. |



## Run the sample



This project has a [dev container configuration](.devcontainer/), which makes it easier to develop apps locally, deploy them to Azure, and monitor them. The easiest way to run this sample application is inside a GitHub codespace. Follow these steps:



1. Fork this repository to your account. For instructions, see [Fork a repo](https://docs.github.com/get-started/quickstart/fork-a-repo).



1. From the repository root of your fork, select **Code** > **Codespaces** > **+**.



1. In the codespace terminal, run the following commands:



    ```shell

    # Install requirements

    python3 -m pip install -r requirements.txt

    # Create .env with environment variables

    cp .env.sample.devcontainer .env

    # Run database migrations

    python3 manage.py migrate

    # Start the development server

    python3 manage.py runserver

    ```



1. When you see the message `Your application running on port 8000 is available.`, click **Open in Browser**.



### Quick deploy



This project is designed to work well with the [Azure Developer CLI](https://learn.microsoft.com/azure/developer/azure-developer-cli/overview), which makes it easier to develop apps locally, deploy them to Azure, and monitor them. 



🎥 Watch a deployment of the code in [this screencast](https://www

.youtube.com/watch?v=JDlZ4TgPKYc).



Steps for deployment:



1. Sign up for a [free Azure account](https://azure.microsoft.com/free/)

2. Install the [Azure Dev CLI](https://learn.microsoft.com/azure/developer/azure-developer-cli/install-azd). (If you opened this repository in a Dev Container, it's already installed for you.)

3. Initialize a new `azd` environment:



    ```shell

    azd init

    ```



    It will prompt you to provide a name (like "django-app"), which will later be used in the name of the deployed resources.



4. Provision and deploy all the resources:



    ```shell

    azd up

    ```



    It will prompt you to login, pick a subscription, and provide a location (like "eastus"). Then it will provision the resources in your account and deploy the latest code. If you get an error with deployment, changing the location (like to "centralus") can help, as there may be availability constraints for some of the resources.



5. When `azd` has finished deploying, you'll see an endpoint URI in the command output. Visit that URI, and you should see the front page of the restaurant review app! 🎉 If you see an error, open the Azure Portal from the URL in the command output, navigate to the App Service, select Logstream, and check the logs for any errors.



    ![Screenshot of Django restaurants website](screenshot_website.png)



6. If you'd like to access `/admin`, you'll need a Django superuser. Navigate to the Azure Portal for the App Service, select SSH, and run this command:



    ```shell

    python3 manage.py createsuperuser

    ```



7. When you've made any changes to the app code, you can just run:



    ```shell

    azd deploy

    ```



## Getting help



If you're working with this project and running into issues, please post in [Issues](/issues).