Skip to content
This repository


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Databrowse is a Django application that lets you browse your data.

branch: master

Django Databrowse

travis-cli tests status for django-databrowse

Databrowse is a Django application that lets you browse your data.

As the Django admin dynamically creates an admin interface by introspecting your models, Databrowse dynamically creates a rich, browsable Web site by introspecting your models.


django-databrowse is available on pypi

So easily install it by pip

$ pip install django-databrowse

Or by easy_install

$ easy_install django-databrowse

Another way is by cloning django-databrowse's git repo

$ git clone git://

Then install it by running:

$ python install

How to use Databrowse

  1. Point Django at the default Databrowse templates. There are two ways to do this:

    • Add 'django_databrowse' to your INSTALLED_APPS setting. This will work if your TEMPLATE_LOADERS setting includes the app_directories template loader (which is the case by default). See the template loader docs for more.
    • Otherwise, determine the full filesystem path to the django_databrowse/templates directory, and add that directory to your TEMPLATE_DIRS setting.
  2. Register a number of models with the Databrowse site:

    import django_databrowse
    from myapp.models import SomeModel, SomeOtherModel, YetAnotherModel, YetAnotherModel)

    Note that you should register the model classes, not instances.

    it is possible to register several models in the same call to

    It doesn't matter where you put this, as long as it gets executed at some point. A good place for it is in your URLconf file (

  3. Change your URLconf to import the ~django_databrowse module:

    from django_databrowse

    ...and add the following line to your URLconf:


    The prefix doesn't matter -- you can use databrowse/ or db/ or whatever you'd like.

  4. Run the Django server and visit /databrowse/ in your browser.

Requiring user login

You can restrict access to logged-in users with only a few extra lines of code. Simply add the following import to your URLconf:

from django.contrib.auth.decorators import login_required

Then modify the URLconf so that the view is decorated with django.contrib.auth.decorators.login_required:

(r'^databrowse/(.*)', login_required(,

If you haven't already added support for user logins to your URLconf, as described in the user authentication docs, then you will need to do so now with the following mapping:

(r'^accounts/login/$', 'django.contrib.auth.views.login'),

The final step is to create the login form required by django.contrib.auth.views.login. The user authentication docs provide full details and a sample template that can be used for this purpose.

Something went wrong with that request. Please try again.