Django Fiber

Do you want to see a Django Fiber screencast, to get a feel for what it can do for you? Check it out here: http://vimeo.com/ridethepony/django-fiber

Or, if you want to quickly try out Django Fiber on your machine, install the Django Fiber example project: https://github.com/ridethepony/django-fiber-example

Convinced? Want to use Django Fiber in your own Django project? Then follow the instructions below:

Installation

We're assuming you are using Django 1.4-1.8.

$ pip install django-fiber

Requirements

These dependencies are automatically installed:

Pillow==2.2.1
django-mptt==0.6.1
django_compressor==1.4
djangorestframework==2.3.8,<3.0
easy-thumbnails==2.2

Settings

settings.py

import django.conf.global_settings as DEFAULT_SETTINGS

MIDDLEWARE_CLASSES = DEFAULT_SETTINGS.MIDDLEWARE_CLASSES + (
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'fiber.middleware.ObfuscateEmailAddressMiddleware',
    'fiber.middleware.AdminPageMiddleware',
)

TEMPLATE_CONTEXT_PROCESSORS = DEFAULT_SETTINGS.TEMPLATE_CONTEXT_PROCESSORS + (
    'django.core.context_processors.request',
)

INSTALLED_APPS = (
    ...
    'django.contrib.staticfiles',
    'mptt',
    'compressor',
    'easy_thumbnails',
    'fiber',
    ...
)

import os
BASE_DIR = os.path.abspath(os.path.dirname(__file__))

STATIC_ROOT = os.path.join(BASE_DIR, 'static')
STATIC_URL = '/static/'
STATICFILES_FINDERS = DEFAULT_SETTINGS.STATICFILES_FINDERS + (
    'compressor.finders.CompressorFinder',
)

urls.py

from django.conf import settings

urlpatterns = patterns('',
    ...
    (r'^api/v2/', include('fiber.rest_api.urls')),
    (r'^admin/fiber/', include('fiber.admin_urls')),
    (r'^jsi18n/$', 'django.views.i18n.javascript_catalog', {'packages': ('fiber',),}),
    ...
    (r'', 'fiber.views.page'),
)

Post-installation

Create database tables for Django >= 1.7

$ python manage.py migrate

Create database tables for Django < 1.7:

$ python manage.py syncdb

Migrating database tables for Django < 1.7 using South 1.0:

$ python manage.py migrate

Then the original South migrations in the south_migrations directory will be used, following the recommendation at http://south.readthedocs.org/en/latest/releasenotes/1.0.html#library-migration-path

All static Fiber files need to be symlinked in (or copied to) your media folder:

$ python manage.py collectstatic --link

Further documentation

For further usage and configuration details take a look at our documentation project at readthedocs.

Changelog

See CHANGELOG.md for the latest changes.