django-wakawaka 1.0

Installation:

1. Put wakawaka to your INSTALLED_APPS in your settings.py within your django project.

2. Add (r'^wiki/', include('wakawaka.urls')), to your urls.py.

That’s all. Wakawaka has no other dependencies than Django 1.0 (or Django 1.1, currently known as trunk)

Private wiki: If you want to deploy a private wiki so that every page needs an login simply add this line (r'^wiki/', include('wakawaka.urls.authenticated')), to your urls.py instead of the above.

Configuration:

Wakawaka takes care of Django’s permission system. Grant your users always a pair of wikipage and revision permissions either what they should do. (Adding, changing or deleting WikiPages)

WAKAWAKA_DEFAULT_INDEX = 'Home'

WAKAWAKA_SLUG_REGEX = r'((([A-Z]+[a-z]+){2,})(/([A-Z]+[a-z]+){2,})*)'

Attachments:

Wakawaka does not provide the ability to store file attachments to wiki pages. To do so, have a look on the side project django-attachments which provides a unobstrusive way to add attachments to models.

Testing and Development:

The project comes with a (not so) comprehensive test library which can be simply invoked by Tox, which tests the project under all current Python and Djanog versions:

$ pip install tox
$ tox

To run the testsuite manually in your development environment, install the project in a separate virtualenv. I’m using virtualenvwrapper here:

$ mkvirtualenv --python=`which python3` wakawaka-env
$ pip install -e .
$ ./runtests.py

Example Project:

The application comes with a sample project. This gives you a brief overview about the Wiki features, and can help you with the integration of the application into an existing project. It’s alo used for the test suite:

$ mkvirtualenv --python=`which python3` wakawaka-env
$ pip install -e .
$ ./runtestproject.py migrate
$ ./runtestproject.py createsuperuser
$ ./runtestproject.py runserver