django-cookbook

Django Cookbook

How to Read “Django”

Target Environment

• Python 3.12 with Django 4.2 (DRF)
• Database: PostgreSQL 16
• Cache: Redis 7/8
• Linting & Type Checking: Ruff, Mypy
• Colorful Logging
• Debug Toolbar

Quick Start

Requirements

• Python 3.12
• PostgreSQL 16 (See Setup PostgreSQL)
• Redis 7/8 (See Setup Redis)

Setup

cp -r pyproject.toml lint.bash .pre-commit-config.yaml .vscode/ <target-path>

# Modify pyproject.toml

cd <target-path>
uv sync

$ uv run --env-file .env django-admin version
4.2.x

uv run --env-file .env django-admin startproject <target-project>

# Create App
uv run --env-file .env python <target-project>/manage.py startapp <app_name>
mv <app_name> <target-project>/.

# Modify settings.py

# Run
uv run --env-file .env python <target-project>/manage.py makemigrations
uv run --env-file .env python <target-project>/manage.py migrate
uv run --env-file .env python <target-project>/manage.py createsuperuser
uv run --env-file .env python <target-project>/manage.py runserver [localhost:8000]

Lint

chmod u+x lint.bash
./lint.bash

More

• PostgreSQL CLI: psql Usage - Linux Cookbook
• Redis CLI: redis-cli Basic Usage - Linux Cookbook
• Redis Python API: redis-py - Python Coobook
• Logging Usage - Python Cookbook
• Logging Dictionary Configuration - Python Cookbook

References

• Django Documentation
• django-stubs PyPI
• PostgreSQL Home
• psycopg Documetation
• Django Cache Framework
• Redis Documentation
• redis-py Documentation
• Django Logging
• django-debug-toolbar Documentation
• django-rest-framework Home

This site is open source. Improve this page.