Django

Overview

Django is a high-level Python web framework that encourages rapid development and clean, pragmatic design. It includes an ORM, admin panel, authentication system, and templating engine built in.

Quick Start

git clone https://<git-server>/<username>/<repo-name>.git
cd <repo-name>

pip install -r requirements.txt

python manage.py migrate
python manage.py runserver

git add .
git commit -m "Initial setup"
git push origin main

Local Development with Docker

If you don't have Python installed locally, you can use Docker to run your Django application.

Running Commands with Docker

# Install dependencies
docker run --rm -v $(pwd):/app -w /app python:3.12 pip install -r requirements.txt

# Run development server
docker run --rm -v $(pwd):/app -w /app -p 8000:8000 python:3.12 sh -c "pip install -r requirements.txt && python manage.py runserver 0.0.0.0:8000"

Database Configuration

The NStrim platform provides you with a MySQL/MariaDB database. Update the DATABASES setting in your settings.py file.

Update settings.py

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': '<username>',
        'USER': '<username>',
        'PASSWORD': '<password>',
        'HOST': 'db.<session-domain>',
        'PORT': '3306',
    }
}

Project Structure

├── project/
│   ├── settings.py            # Project configuration
│   ├── urls.py                # Root URL configuration
│   └── wsgi.py                # WSGI entry point
├── app/
│   ├── models.py              # Database models
│   ├── views.py               # View functions / classes
│   ├── urls.py                # App URL patterns
│   ├── serializers.py         # DRF serializers
│   ├── admin.py               # Admin panel config
│   └── templates/             # HTML templates
├── static/                    # CSS, JS, images
├── manage.py                  # Django management CLI
├── requirements.txt           # Python dependencies
└── Dockerfile                 # Docker config
        

Common Tasks

Creating a Model

from django.db import models

class User(models.Model):
    name = models.CharField(max_length=100)
    email = models.EmailField(unique=True)
    created_at = models.DateTimeField(auto_now_add=True)

    def __str__(self):
        return self.name

Creating a View

from django.http import JsonResponse
from .models import User

def user_list(request):
    users = list(User.objects.values('id', 'name', 'email'))
    return JsonResponse(users, safe=False)

URL Configuration

from django.urls import path
from . import views

urlpatterns = [
    path('users/', views.user_list, name='user-list'),
]

Useful Commands

Troubleshooting

Deployment Workflow