Skip to content
/ waliki Public

A wiki engine powered by Django and Git

License

Notifications You must be signed in to change notification settings

mgaitan/waliki

Repository files navigation

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

Attention!

It's usable but in an early development stage. I'll appreciate your feedback and help.

https://badge.fury.io/py/waliki.png https://travis-ci.org/mgaitan/waliki.png?branch=master https://coveralls.io/repos/mgaitan/waliki/badge.png?branch=master Documentation Status Wheel Status
home:https://github.com/mgaitan/waliki/
demo:http://waliki.pythonanywhere.com
documentation:http://waliki.rtfd.org
twitter:@Waliki_ // @tin_nqn_
group:https://groups.google.com/forum/#!forum/waliki-devs
license:BSD

At a glance, Waliki has these features:

  • File based content storage.
  • Version control and concurrent edition for your content using Git
  • Extensible architecture with plugins
  • Markdown or reStructuredText support. Easy to add more.
  • A simple ACL system
  • Per page attachments
  • UI based on Twitter's Bootstrap and CodeMirror.
  • Works with Python 2.7, 3.3, 3.4 or PyPy in Django 1.5 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
    ...
)

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

Tip

Already have content? Put it in your WALIKI_DATA_DIR and run:

$ python manage.py sync_waliki

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 bolivian president Evo Morales.

[1]wiki itself is a hawaiian word