django-databrowse 1.3

Databrowse is a Django application that lets you browse your data.
<hr class="docutils"/>

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.

Installation

django-databrowse is available on pypi

http://pypi.python.org/pypi/django-databrowse

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://github.com/Alir3z4/django-databrowse.git

Then install it by running:

$ python setup.py 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
    
    django_databrowse.site.register(SomeModel)
    django_databrowse.site.register(SomeOtherModel, YetAnotherModel)
    

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

    it is possible to register several models in the same call to django_databrowse.site.register.

    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 (urls.py).

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

    from django_databrowse
    

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

    (r'^django_databrowse/(.*)', django_databrowse.site.root),
    

    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 django_databrowse.site.root view is decorated with django.contrib.auth.decorators.login_required:

(r'^databrowse/(.*)', login_required(django_databrowse.site.root)),

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.

Copyright (c) 2005-2013 Django [Contributors|Foundation], Alireza Savand
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of the authors nor the
      names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Author

Alireza Savand

Pip

django-databrowse==1.3

Classifiers

  • Topic :: Software Development
  • Programming Language :: Python :: 2.7
  • Programming Language :: Python
  • Operating System :: OS Independent
  • Intended Audience :: Developers
  • Framework :: Django
  • Environment :: Web Environment
  • Development Status :: 5 - Production/Stable
File Type Python Version Uploaded On Downloads
django-databrowse-1.3.tar.gz Source Nov. 29, 2013 1,690
Version Release Date
1.3 Nov. 29, 2013
1.2 June 10, 2013
1.1 Feb. 21, 2013
1.0 Jan. 8, 2013
2014.9.26 Sept. 26, 2014
Date Package Version Action
Nov. 4, 2014, 1:04 p.m. django-databrowse 1.3 Release Created
Nov. 4, 2014, 1:04 p.m. django-databrowse 1.2 Release Created
Nov. 4, 2014, 1:04 p.m. django-databrowse 1.1 Release Created
Nov. 4, 2014, 1:04 p.m. django-databrowse 1.0 Release Created
Nov. 4, 2014, 1:04 p.m. django-databrowse 2014.9.26 Release Created
Nov. 4, 2014, 1:04 p.m. django-databrowse Package Created