scribe : documentation

Installation instructions for Scribe

This document is for Scribe's SVN release, which can be significantly different than previous releases. Get old docs here: 0.60.

This document assumes that you have already installed Django. Please visit Django’s installation pages for information about how to install it. It is preferable that you have experience with Django.

Requirements

  • Python 2.4
  • Django 0.97

Install Scribe

Create a new Django project, and add scribe and extras to your project:

django-admin.py startproject newproject
cd newproject/
svn co svn://fadingred.org/django/scribe/trunk scribe
svn co svn://fadingred.org/django/extras/trunk extras

Database Setup

Make sure that your database is set up in the settings.py file and that the database exists as well.

And at the bottom of the settings.py file add:

from scribe import setup
setup(__name__)

Note that it is possible to setup Scribe manually. We provide this method of setup for convenience, but realize that it isn’t perfect for all situations. For instance, the default setup uses database caching, but other caching techniques may be better or faster depending on how your server is configured. Please read the settings document for more information.

URL Configuration

Edit your urls file to look something like this:

from django.conf.urls.defaults import *
from scribe.urls import add_debug_urls
urlpatterns = patterns('',
  (r'^', include('scribe.urls')),
)
add_debug_urls(urlpatterns)

Note that adding debug urls is optional. It enables you to run and test your blog with the default css stylesheets enabled so that it looks like what it would really look like.

Preferences

Within the scribe module, change preferences.tmpl to preferences.py and set up your preferences how you’d like.

Running things

In your project module run (one at a time and follow any onscreen instructions):

python manage.py syncdb
python manage.py createcachetable scribe_cache
python manage.py runserver

You’re now up and running on your local machine. Go to http://localhost:8000/ and start using the blog. http://localhost:8000/admin/ is where you can log in to create articles. If you’re having any problems run the built-in tests:

python manage.py test

Questions/Feedback

If you notice errors with this documentation, please open a ticket and let us know!