How to Create Django Models: Complete Tutorial

How to Create Django Models: A Step-by-Step Guide

Django models are the foundation of any Django application, providing a clear way to define your application’s data structure in Python code. This tutorial guides you through creating Django models efficiently and correctly, helping you leverage Django’s powerful Object-Relational Mapping (ORM) system.

Prerequisites

Python installed on your system (version 3.6 or higher recommended)
Django installed in your Python environment (Use pip install django)
Basic familiarity with Python programming and object-oriented concepts
Some understanding of database concepts (tables, fields, relationships)

Step 1: Set Up a Django Project (If Not Done Already)

Start by creating a Django project. You may refer to our tutorial How to Create a Django Project: A Step-by-Step Tutorial for detailed instructions.

In short, open your terminal and run:

django-admin startproject myproject
cd myproject
python manage.py startapp myapp

You have now created a new project named myproject and an app called myapp.

Step 2: Define Models in Your App

Within your app folder (myapp), open the models.py file. This is where you define your models, which correspond to database tables.

Example: Creating a Simple Blog Post Model

from django.db import models

class Post(models.Model):
    title = models.CharField(max_length=200)  # Short text field
    content = models.TextField()              # Large text field
    created_at = models.DateTimeField(auto_now_add=True)  # Timestamp when created
    updated_at = models.DateTimeField(auto_now=True)      # Timestamp on update

    def __str__(self):
        return self.title

Explanation:

models.Model: The base class for all Django models.
CharField: Stores string data with a maximum length.
TextField: Stores large text without length limits.
DateTimeField: Stores date and time, with options for auto-populating.
__str__ method provides a human-readable string representation.

Step 3: Add Your App to the Project Settings

Make sure your app is listed in the INSTALLED_APPS list in settings.py so Django knows to include its models.

INSTALLED_APPS = [
    ...
    'myapp',
]

Step 4: Create and Apply Migrations

Django uses migrations to propagate your model definitions to the database schema.

Run the following commands:

python manage.py makemigrations myapp
python manage.py migrate

The first command generates migration files based on your model changes. The second applies them to the database.

Step 5: Using Your Models in Django Admin (Optional)

To manage your models through the Django admin interface, register your model in admin.py:

from django.contrib import admin
from .models import Post

admin.site.register(Post)

Run the development server with python manage.py runserver, navigate to /admin, and log in with your superuser account. You can add, edit, and delete instances of Post here.

Step 6: Advanced Model Features

Relationships: Define ForeignKey, OneToOneField, or ManyToManyField to relate models.
Custom Methods: Add methods to your model class for extra functionality.
Meta Options: Use the class Meta: inside models to set ordering, unique constraints, and more.

Example adding a foreign key relationship:

class Comment(models.Model):
    post = models.ForeignKey(Post, on_delete=models.CASCADE, related_name='comments')
    author_name = models.CharField(max_length=100)
    text = models.TextField()
    created_at = models.DateTimeField(auto_now_add=True)

    def __str__(self):
        return f'Comment by {self.author_name}'

Troubleshooting Tips

If migrations don’t reflect changes, try deleting migrations folder in the app (except __init__.py) and remake migrations.
Ensure your app is in INSTALLED_APPS.
Double-check field names and types for typos.
Run python manage.py shell to test model queries interactively.

Summary Checklist

Install Django and create project/app
Define models in models.py
Add app to INSTALLED_APPS
Make and apply migrations
Optionally, register models in admin
Use models in views or shell for database operations

Django models simplify database interactions and streamline development. With this guide, you can confidently create and manage your app’s data structure using Django’s robust ORM.

For further Django development tips, explore our related tutorial on How to Install Python Django Framework: Step-by-Step Guide.