django-cab 0.3.4

Installation notes

Cab has a couple of external dependencies:

• Pygments for code highlighting.

• python-markdown for processing snippet descriptions. Other Python ports of Markdown will not work, since the code which calls Markdown assumes the existence of python-markdown’s “safe mode”.

• django-simple-ratings for item ranking

• django-taggit for tagging

• django-haystack for search

Additionally, the default setup requires a few applications which are bundled with Django itself:

• django.contrib.comments to enable commenting.

• django.contrib.markup to handle Markdown formatting of comments.

• django.contrib.syndication to enable feeds.

It’s also recommended that you have django.contrib.admin installed for ease of site maintenance.

Once you’ve got those taken care of, grab a git checkout of Cab from somewhere on your Python path:

git clone git://github.com/django-de/djangosnippets.org.git

Then add ratings, taggit and cab to the INSTALLED_APPS setting of your Django project, run manage.py syncdb, and either put a call to include('cab.urls.snippets') somewhere inn your root URLConf or copy over the URL patterns from Cab that you want to use.

Note that the get_absolute_url methods of the Language, Snippet and Tag models assume that they will live under the URLs /languages/, /snippets/ and /tags/, so if you want them to go elsewhere you’ll need to edit those methods or ovveride them with Django’s ABSOLUTE_URL_OVERRIDES setting.

For search support you need to set up a search engine and configure haystack:

# Place where search indexes are stored for snippets - should be non web accessible
HAYSTACK_CONNECTIONS = {
    'default': {
        'ENGINE': 'haystack.backends.whoosh_backend.WhooshEngine',
        'PATH': '/some-path/search-index',
        'STORAGE': 'file',
        'POST_LIMIT': 128 * 1024 * 1024,
        'INCLUDE_SPELLING': True,
        'BATCH_SIZE': 100,
    },
}
HAYSTACK_SIGNAL_PROCESSOR = 'haystack.signals.RealtimeSignalProcessor'

Templates

The git repo will get you a set of example templates matching those currently in use on djangosnippets.org

OMGWTF Tests?

Yeah, there are tests now. See https://travis-ci.org/django-de/django-cab