Use Database URLs in your Django Application.
Find a file
Kenneth Reitz 0400f59e6d fixed url
2012-06-21 12:04:16 -04:00
.travis.yml travis tests 2012-06-19 11:24:53 -04:00
dj_database_url.py python3 support 2012-06-19 11:53:51 -04:00
LICENSE lawyer up 2012-04-30 13:43:46 -04:00
Makefile tests 2012-06-19 11:03:52 -04:00
README.rst fixed url 2012-06-21 12:04:16 -04:00
setup.py fixed url 2012-06-21 12:04:16 -04:00
test_dj_database_url.py test environment variables 2012-06-19 11:23:05 -04:00

DJ-Database-URL
~~~~~~~~~~~~~~

.. image:: https://secure.travis-ci.org/kennethreitz/dj-database-url.png?branch=master

This simple Django utility allows you to utilize the
`12factor <http://www.12factor.net/backing-services>`_ inspired
``DATABASE_URL`` environment variable to configure your Django application.


Usage
-----

Configure your database in ``settings.py`` from ``DATABASE_URL``::

    DATABASES = {'default': dj_database_url.config()}

Parse an arbitrary Database URL::

    DATABASES = {'default': dj_database_url.parse('postgres://...')}

Supported databases
-------------------

Support currently exists for PostgreSQL, PostGIS, MySQL and SQLite.

SQLite connects to file based databases. The same URL format is used, omitting
the hostname, and using the "file" portion as the filename of the database.
This has the effect of four slashes being present for an absolute file path:
``sqlite:////full/path/to/your/database/file.sqlite``.

Installation
------------

Installation is simple too::

    $ pip install dj-database-url