Backend EST API with Python & Django

Create an advanced REST API with Python, Django REST Framework and Docker using Test Driven Development (TDD)

Table of Contents

1. About

2. Main Objectives

3. Tech Topics Covered

4. Icons Library

5. Official Web Resources

6. Additional Resources

7. Tech Issues and Problem Solving

8. Django App:

   • Django App Configuration Files
   • Core app

About

The advanced course on how to Build a Backend REST API using Python, Django (2.0), Django REST Framework (3.9), Docker, Travis CI, Postgres and Test Driven Development!

The original course content was created by Mark Winterbottom.

The main goal is to built a fully functioning REST API that can handle

• User authentication
• Creating objects
• Filtering and sorting objects
• Uploading and viewing images

Additional topics covered

• Setup a project with Docker and Docker-Compose
• Configure Travis-CI to automatically run linting and unit tests
• Write unit tests using the Django Test Framework
• Apply best practice principles including Test Driven Development
• Handle uploading media files with Django
• Customize the Django admin
• Configure a Postgres database

Official Web Resources

• Python
• Django
• Django REST Framework
• Docker
• Travis-CI
• PostgreSQL
• GitHub

Additional Resources

• GitHub Desktop
• PyCharm

Tech Issues and Problem Solving

The first thing you should do when you install Git is to set your user name and email address. This is important because every Git commit uses this information, and it’s immutably baked into the commits you start creating:

  git config --global user.name "John Doe"
  git config --global user.email johndoe@example.com

Source

1. In the Settings/Preferences dialog (Ctrl+Alt+S), select Project | Project Interpreter.
2. Expand the list of the available interpreters and click the Show All link.
3. Select the target interpreter. When PyCharm stops supporting any of the outdated Python versions, the corresponding project interpreter is marked as unsupported.
4. The Python interpreter name specified in the Name field, becomes visible in the list of available interpreters. Click OK to apply the changes.

For more info please check here

1. Open the Settings/Preferences dialog, and under the node Tools, click the page Python Integrated Tools.
2. On this page, click the Default Test Runner field.
3. Choose the desired test runner:

For more info please see Enable Pytest for you project

1. open CMD
2. navigate to project directory, for example:

cd C:\Users\superadmin\Desktop\Python\CodinGame

3. run following command:

pip install virtualenv

4. run following command:

virtualenv venv --python=python

1. The package is called python-pip. First check if it's already installed: pacman -Qs python-pip

2. If there is no output after running the above command, that means that the package is not installed. In order to install it, run: sudo pacman -Syu python-pip

3. In order to install virtualenv run: pip install virtualenv

4. You also need to run sudo /usr/bin/easy_install virtualenv which puts it in /usr/local/bin/.

Source

How to install virtualenv

1. Install pip first

    sudo apt-get install python3-pip

2. Then install virtualenv using pip3

    sudo pip3 install virtualenv

3. Now create a virtual environment

    virtualenv venv

you can use any name insted of venv

4. You can also use a Python interpreter of your choice:

    virtualenv -p /usr/bin/python2.7 venv

5. Active your virtual environment:

    source venv/bin/activate

6. Using fish shell:

    source venv/bin/activate.fish

7. To deactivate:

    deactivate

8. Create virtualenv using Python3:

    virtualenv -p python3 myenv

9. Instead of using virtualenv you can use this command in Python3:

    python3 -m venv myenv

Source

In a newly created virtualenv there will be a bin/activate shell script. For Windows systems, activation scripts are provided for CMD.exe and Powershell.

1. Open Terminal
2. Run: \path\to\env\Scripts\activate

Source

Any application typically has a set of dependencies that are required for that application to work. The requirements file is a way to specify and install specific set of package dependencies at once. Use pip’s freeze command to generate a requirements.txt file for your project:

pip freeze > requirements.txt

If you save this in requirements.txt, you can follow this guide: PyCharm - Manage dependencies using requirements.txt, or you can:

pip install -r requirements.txt

Source

Step by step:

# Step 1: Update your repositories
sudo apt-get update

# Step 2: Install pip for Python 3
sudo apt-get install build-essential libssl-dev libffi-dev python-dev
sudo apt install python3-pip

# Step 3: Use pip to install virtualenv
sudo pip3 install virtualenv 

# Step 4: Launch your Python 3 virtual environment, here the name of my virtual environment will be `venv`
virtualenv -p python3 venv

# Step 5: Activate your new Python 3 environment. There are two ways to do this
. venv/bin/activate # or source env3/bin/activate which does exactly the same thing

# you can make sure you are now working with Python 3
python -- version

# this command will show you what is going on: the python executable you are using is now located inside your virtualenv repository
which python 

# Step 6: code your stuff

# Step 7: done? leave the virtual environment
deactivate

Source

1. Older versions of Docker were called docker, docker.io, or docker-engine. If these are installed, uninstall them:

sudo apt-get remove docker docker-engine docker.io containerd runc

2. Update the apt package index and install packages to allow apt to use a repository over HTTPS:

sudo apt-get update

sudo apt-get install \
      apt-transport-https \
      ca-certificates \
      curl \
      gnupg-agent \
      software-properties-common

3. Add Docker’s official GPG key:

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -

# Verify that you now have the key with the fingerprint
sudo apt-key fingerprint 0EBFCD88

4. Use the following command to set up the stable repository:

sudo add-apt-repository \
"deb [arch=amd64] https://download.docker.com/linux/ubuntu \
(lsb_release -cs) \
stable"

5. Update the apt package index, and install the latest version of Docker Engine and container:

sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io

6. Verify that Docker Engine is installed correctly by running the hello-world image:

sudo docker run hello-world

This command downloads a test image and runs it in a container. When the con