Django guide and Cheet sheet

A guide to setting up Django, together with some basic cheat sheet commands

Installation for Python2.7 (legacy)

pip install Django==1.11.9

Installation for Python3

python -m pip install Django

Get Django current version

python -m django --version

---

Create a new virtual environment for Python2

pip install virtualenv
virtualenv project_name

Activate the virtual environment

source bin/activate

Create vitual environment for Python3

python3 -m venv virtual_environment_name

Deactivate (exit) the virtual environment

deactivate

---

Start a project

django-admin startproject project_name

---

Generate migrations (if any)

python manage.py showmigrations

python manage.py makemigrations

python manage.py migrate

---

Create an application in the project

python manage.py startapp application-name

Please note that a single project can have multiple applications inside it Do not forget to include the new project in settings.py:

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'application-name'
]

---

Collect static files (if any)

python manage.py collectstatic

---

Edit settings.py

vim project-name/settings.py

These are the settings of the entire project not the applications!

---

Create a superuser

python manage.py createsuperuser

The command will ask for username, password and email to be provided If you have Django admin module enabled, this user will be able to login in the panel

---

Run server

python manage.py runserver 0.0.0.0:8000

---

Models not showing up in Django admin

All models, which you would like to be shown in the Django admin, must be manually specified in the admin.py file inside your application directory. Below is an example with a model named Product

Define your model in models.py

class Product(models.Model):

    # Name of the product
    name                = models.CharField(max_length=128, default=None, blank=True, null=True)

    # Description of the product
    description         = models.TextField(max_length=8096, default=None, blank=True, null=True)

    # Date when the product is created
    date_posted         = models.DateTimeField(default=datetime.now)

    # Return name: otherwise it is not shown in the Django Admin
    def __unicode__(self):
        return self.content

Add to admin.py

# REQUIRED: All custom models which need to be shown in Django admin, must be manually INCLUDED here:
from .models import Product

# REQUIRED: All custom models which need to be shown in Django admin, must be manually also REGISTERED here:
admin.site.register(Product)