django-briefcase

django-briefcase is yet another document management app for Django.

Features

  • semi-generic document-related views
  • filtering documents by their extension
  • integration with Django admin site
  • ...more to come :)

Contents

Installation

Get the code

You can install the package from PyPI:

pip install django-briefcase

or:

easy_install django-briefcase

Any packages that django-briefcase depends on, will be automatically downloaded (currently this is Django and South).

Stable releases are located at PyPI. The development version can be installed from Github:

git clone git://github.com/zsiciarz/django-briefcase.git
cd django-briefcase
python setup.py install

or if you’re using pip:

pip install -e git+git://github.com/zsiciarz/django-briefcase.git#egg=django-briefcase

Configure your project

Add briefcase to your INSTALLED_APPS in settings.py. Then, run python manage.py migrate briefcase to create document-related database tables.

Note

If you don’t use South, run python manage.py syncdb, however using South to handle your database schema history is recommended.

Usage

Right after Installation you can manage your documents from the Django admin site. To actually present them in the front-end, hook the application views into your URLconf.

Example:

urlpatterns = patterns('briefcase.views',
    #...
    url(r'^recent_documents/',
        'general.recent_documents',
        name='recent_documents'
    ),
    url(r'^my_documents/',
        'per_user.my_documents',
        name='my_documents'
    ),
    url(r'^download/(?P<document_id>\d+)/$',
        'general.download_document',
        name='download_document'
    ),
    #...
)

Follow the Document-related views reference for a detailed documentation of all views.