dj-database-url

What it is and what it does

dj-database-url is a lightweight utility that converts DATABASE_URL environment variables into Django database configuration dictionaries. It implements the 12factor pattern for backing services, allowing you to externalize database connection details into environment variables rather than hardcoding them in settings.py. The package handles URL parsing for multiple database engines—PostgreSQL, MySQL, Oracle, SQLite, PostGIS, Redshift, CockroachDB, Timescale, and others—and automatically maps them to the correct Django backend.

The main entry points are config() (reads from DATABASE_URL environment variable with optional fallback) and parse() (accepts a URL string directly). Both return a Django DATABASES dictionary entry. The package also supports Django's connection pooling via conn_max_age and health checks via conn_health_checks, and allows registration of custom database backends with optional post-processing functions for non-standard configuration needs.

Use it for:

• Containerized deployments where database credentials are injected via environment variables at runtime.
• Multi-environment setups (dev, staging, production) using the same code with different DATABASE_URL values.
• Enabling connection pooling and health checks in Django without manual DATABASES dictionary construction.
• Supporting non-standard or custom database backends by registering them with dj_database_url.register().
• Migrating from hardcoded database settings to environment-driven configuration in existing Django projects.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Parses DATABASE_URL environment variables into Django database configuration dictionaries, supporting PostgreSQL, MySQL, Oracle, SQLite, and other backends with optional connection pooling.

Yes. This is a stable, actively maintained utility with zero known vulnerabilities, low install friction, and broad database backend support. It directly solves the common problem of externalizing database configuration in Django applications and is widely used in containerized and cloud-deployed environments. Install it if you use Django and want to follow 12factor principles for database configuration.

Install

dj-database-url on PyPI

pip install dj-database-url

uv add dj-database-url

poetry add dj-database-url

Installing dj-database-url

Before you install

Low friction: single dependency on django, wheel-only distribution, actively maintained with recent commits. Supports current Python versions (3.10–3.14) and Django 4.2 through 6.

License in practice

BSD-3-Clause (permissive): you may use, modify, and distribute this package freely in commercial and private projects with minimal restrictions.

Quickstart

import dj_database_url

DATABASES = {
    'default': dj_database_url.config(
        conn_max_age=600,
        conn_health_checks=True,
    )
}

Requires DATABASE_URL environment variable to be set, or a default URL passed to config(); special characters in URLs must be percent-encoded.

Verify before relying

• Whether custom backend registration persists across application reloads or requires per-request setup.
• Performance impact of connection health checks on request latency in high-throughput scenarios.

Package facts

Evidence: dj_database_url-3.1.2-py3-none-any.whl

Tags

More Python Modules packages