pombredanne / waliki Goto Github PK

Waliki is an extensible wiki app for Django with a Git backend.

At a glance, Waliki has this features:

• File based content storage.
• UI based on Bootstrap and CodeMirror
• Version control and concurrent edition for your content using git
• An extensible architecture with plugins
• reStructuredText or Markdown support, configurable per page (and it's easy to add extensions)
• A very simple per slug ACL system
• A nice page attachments manager (that respects the page permissions)
• Realtime collaborative edition via togetherJS
• Wiki content embeddable in any django template (as a "dummy CMS")
• Few helpers to migrate content (particularly from MoinMoin, using moin2git)
• It works with Python 2.7, 3.3, 3.4 or PyPy in Django 1.6 or newer

How to start

Install it with pip:

$ pip install waliki[all]

Or the development version:

$ pip install https://github.com/mgaitan/waliki/tarball/master

Add waliki and the optionals plugins to your INSTALLED_APPS:

INSTALLED_APPS = (
    ...
    'waliki',
    'waliki.git',           # optional but recommended
    'waliki.attachments',   # optional but recommended
    'waliki.pdf',           # optional
    'waliki.slides',        # optional
    'waliki.togetherjs',    # optional
    ...
)

Include waliki.urls in your project's urls.py. For example:

urlpatterns = patterns('',
    ...
    url(r'^wiki/', include('waliki.urls')),
    ...
)

Sync your database:

$ python manage.py migrate   # syncdb in django < 1.7

$ python manage.py sync_waliki

WALIKI_ANONYMOUS_USER_PERMISSIONS = ('view_page', 'add_page', 'change_page')

Why Waliki ?

Waliki is an Aymara word that means all right, fine.

It sounds a bit like wiki, has a meaningful sense and also plays with the idea of using a non-mainstream language [1] .

And last but most important, it's a humble tribute to the president Evo Morales and the Bolivian people.