Skip to main content

A code snippet manager, originally written to power djangosnippets.org

Project description

Build Status

Cab (named for the jazz bandleader and scat singer Cab Calloway) is a Django application which allows users to post and share useful “snippets” of code.

This code is used to power the snippet sharing site, djangosnippets.org

Installation notes

Cab has a couple of external dependencies:

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-cab-0.3.7.tar.gz (32.0 kB view details)

Uploaded Source

Built Distribution

django_cab-0.3.7-py2.py3-none-any.whl (54.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file django-cab-0.3.7.tar.gz.

File metadata

  • Download URL: django-cab-0.3.7.tar.gz
  • Upload date:
  • Size: 32.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for django-cab-0.3.7.tar.gz
Algorithm Hash digest
SHA256 e4747027a5441bf91ba16940f9dc02c9c9439135df67d61fc1dae5713b814561
MD5 05f5a121a0d7d93032163da25bab6116
BLAKE2b-256 d9f5ded9d38e0217ad83cc83328480d01f03c61aa308b8661d00bb0fcec392d9

See more details on using hashes here.

Provenance

File details

Details for the file django_cab-0.3.7-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for django_cab-0.3.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 13e93afe88767a8dcd52b7860d952d8666298c97f12488fa2be9e27d9caf30e3
MD5 d7785b72ec2b6227c88dfd6cfcb69d52
BLAKE2b-256 5a14fafe38bd598e75f217da24d603fe17f4fe1824f8430643d44aebecfc8a71

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page