Skip to main content

small wiki engine based on static reST files in a directory and git for versionning

Project description

attowiki is a very small wiki engine for personal use.

Its main features are:

  • can be started in any directory
  • uses all .rst files in directory structure as “wiki” files
  • uses git for revision control
  • automatic background saving
  • history view of old version of pages, including source and diff views
  • added 2 new directives: ‘todo’ and ‘done’
  • some meta pages, including:
    • /__index__: gives a list of all meta pages and normal pages
    • /__cheatsheet__: docutils reStructuredText cheat sheet
    • /__todo__: gives a list of all todo found in all pages
    • /__done__: gives a list of all done found in all pages
    • /__xxxxxxx__: gives a list of all xxxxxxx found in all pages, xxxxxxx represent any reStructure node, like all admonitions:
      • __todo__
      • __done__
      • __attention__
      • __caution__
      • __danger__
      • __error__
      • __hint__
      • __important__
      • __note__
      • __tip__
      • __warning__
      • __admonition__
    • “admonition” meta pages for one page only using this kind of url: /name of the doc.__admonitionname__

usage

Launching a wiki

$ attowiki

that’s all.

attowiki will start a small server (by default, serving to http://localhost:8080)

all the .rst files inside the current directory will be used for the wiki

installation

$ pip install attowiki

project dependencies

  • bottle
  • docutils
  • gitpython

Version History

v0.5.1

  • Bug Corrections
    • changed error handling when pdf production fail

v0.5

  • added pdf export button
  • added static file serving as fall back (and 404 still fall back of static files- It’s useful when a reST doc tries to include local files (like images), which are now server by attowiki
  • Bug Corrections
    • git history was not available when serving attowiki in a subdir of a git repo

v0.4

  • added a ‘view diff’ button when viewing a previous version of a file
  • added a ‘view source’ button when viewing a previous version of a file
  • added an history view of previous versions of a file
  • added __todo__ meta page which scan all the directory for todo directives and display it in one page
  • added more generic __xxxxxxxx__ meta page which scan all the directory for the xxxxxxxx admnonition. This may work with any registered node, especially admonitions:
    • __todo__
    • __done__
    • __attention__
    • __caution__
    • __danger__
    • __error__
    • __hint__
    • __important__
    • __note__
    • __tip__
    • __warning__
    • __admonition__
  • added possibility to use the “admonition” meta pages for one page only using this kind of url: /name of the doc.__admonition_name__
  • added __cheatsheet__ meta page which provides locally a docutils reST cheatsheet
  • added ‘done’ directive, in order to work with todo: when a task is done, edit the page and change ‘todo’ to ‘done’ (it will remove it from __todo__ meta page)
  • removed iframe
  • improved docutils css
  • some other refactors

v0.3

  • added todo directive support in rest files (now display correctly a todo)
  • changed a little bit the default docutils css
  • added background saving feature

v0.2

  • start in a dir, looks for .rst files and serve them in html
  • looks for index.rst at first and serve it
  • if index.rst not found serve a page with the list of files
  • simple edition (text area). Save and Cancel buttons
  • git commit when saving

v0.1

  • first (non-working) version

Project details


Release history Release notifications

This version
History Node

v0.5.1

History Node

v0.5

History Node

v0.4.2

History Node

v0.4.1

History Node

v0.4

History Node

v0.3.1

History Node

v0.3

History Node

v0.2.2

History Node

v0.2.1

History Node

v0.2

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
attowiki-v0.5.1.tar.gz (21.6 kB) Copy SHA256 hash SHA256 Source None Sep 17, 2013

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page