django-extensions

Django Extensions provides a wide array of management commands to enhance your Django development workflow. These include tools for database management, model visualization, shell enhancements, and server utilities.

Key categories of commands include:

• Development Utilities: shell_plus, runserver_plus, generate_secret_key, describe_form.
• Database & Migrations: reset_db, reset_schema, sqldiff, sqlcreate, sqldsn, syncdata, delete_squashed_migrations.
• Model & Data Management: graph_models, list_model_info, merge_model_instances, dumpscript.
• Template & File Utilities: validate_templates, find_template, show_template_tags, unreferenced_files.
• System & Debugging: mail_debug, print_settings, runscript, notes.

To use the extensions, add 'django_extensions' to your INSTALLED_APPS setting in settings.py.

INSTALLED_APPS = (
    ...
    'django_extensions',
    ...
)

A job is a Python script containing a class named Job. This class must inherit from one of the following base classes depending on the desired frequency:

• MinutelyJob (requires a minutely directory)
• QuarterHourlyJob (requires a quarter_hourly directory)
• HourlyJob (requires an hourly directory)
• DailyJob (requires a daily directory)
• WeeklyJob (requires a weekly directory)
• MonthlyJob (requires a monthly directory)
• YearlyJob (requires a yearly directory)

Each job class must implement the execute method, which contains the logic to be run.

To completely reset an application's data and reload it from a previously generated dumpscript, use the reset command followed by runscript.

Note: For runscript to work, the directory containing your scripts must be a Python module. You must create the directory and include an __init__.py file within it.

./manage.py reset appname
./manage.py runscript testdata

The sqlcreate command helps you automate the creation of your database(s) by using the configuration already defined in your settings.py. Instead of creating databases manually, you can generate the necessary SQL and pipe it directly into your database's shell command.

Usage Pattern: python manage.py sqlcreate [--database=<databasename>] | <my_database_shell_command>

Note on Permissions: sqlcreate generates the SQL for you to review and pipe into a shell. It does not execute the commands directly because it cannot guarantee the database user in your settings has the necessary administrative permissions to create databases and users.

You can trigger interactive debugger sessions (using ipdb, pdb, or wdb) directly within Django templates by using the debugger_tags template tags. This allows you to inspect objects and variables during the template rendering process.

1. Load the tags in your template using {% load debugger_tags %}.
2. Apply a debugger filter to the object or variable you wish to inspect (e.g., {{ variable|ipdb }}).

Supported filters:

• ipdb
• pdb
• wdb

{% load debugger_tags %}

{% for object in object_list %}
    {{ object|ipdb }}
{% endfor %}

The show_permissions command lists all permissions for the models in your Django project. By default, it excludes built-in Django apps like admin, auth, contenttypes, and sessions. This is useful for inspecting permissions when customizing logic or managing role-based access.

python manage.py show_permissions

You can visually distinguish models by app using a JSON styling file. The file maps app labels (supporting wildcards like django.*) to style dictionaries. Currently, only the bg (background color) option is supported.

Styling Workflow:

1. Create a JSON file (e.g., style.json).
2. Place it in the project root (named .app-style.json) OR specify it via the --app-style flag.
3. Run the command with the -o flag to output an image.

JSON Format Example:

{
  "app1": {"bg": "#341b56"},
  "app2": {"bg": "#1b3956"},
  "django.*": {"bg": "#561b4c"},
  "django.contrib.auth": {"bg": "#c41e3a"}
}

$ ./manage.py graph_models -a --app-style path/to/style.json -o styled_output.png

Use runserver_plus instead of the standard Django runserver to launch a development server with the Werkzeug debugger integrated. This provides interactive tracebacks, source code viewing, and an AJAX-based debugging console. All standard runserver options (like port and host) are supported.

Requirement: You must have Werkzeug installed.

python manage.py runserver_plus

To ensure Werkzeug logs appear in your console, add the following to your Django LOGGING configuration:

LOGGING = {
    'handlers': {
        'console': {
            'level': 'DEBUG',
            'class': 'logging.StreamHandler',
        },
    },
    'loggers': {
        'werkzeug': {
            'handlers': ['console'],
            'level': 'DEBUG',
            'propagate': True,
        },
    },
}