Go to file
Balazs Nadasdi bd8b8791c5
continuous-integration/drone/push Build is passing Details
continuous-integration/drone Build was killed Details
update drone
2020-01-09 12:16:44 +01:00
doku Update readme + bump version 2019-05-07 20:08:05 +02:00
tests Some of them are ugly 2019-05-07 18:38:24 +02:00
.drone.yml update drone 2020-01-09 12:16:44 +01:00
.gitignore Some of them are ugly 2019-05-07 18:38:24 +02:00
.travis.yml py37: unable to download @travis :/ 2019-05-07 20:18:19 +02:00
LICENSE initial commit 2019-02-20 23:09:18 +01:00
MANIFEST.in initial commit 2019-02-20 23:09:18 +01:00
Makefile initial commit 2019-02-20 23:09:18 +01:00
README.rst add travis and coveralls (instead of my drone) 2019-05-07 20:25:19 +02:00
requirements.txt initial commit 2019-02-20 23:09:18 +01:00
setup.py initial commit 2019-02-20 23:09:18 +01:00
test-requirements.txt Some of them are ugly 2019-05-07 18:38:24 +02:00
tox.ini add py36 to tox 2019-05-07 19:29:26 +02:00

README.rst

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

doku
====

.. image:: https://travis-ci.org/yitsushi/doku.svg?branch=master
    :target: https://travis-ci.org/yitsushi/doku

.. image:: https://coveralls.io/repos/github/yitsushi/doku/badge.svg?branch=travis
    :target: https://coveralls.io/github/yitsushi/doku?branch=travis


**doku** is a cli tool to read and manipulate
documents in DokuWiki via its XMLRPC endpoint.

Requirements
~~~~~~~~~~~~

 * Python 3.6+
 * DokuWiki access (somewhere) with enabled XML-RPC

Install
~~~~~~~

::

   pip install doku

   # or as a user
   pip install --user doku

   # upgrade
   pip install --upgrade doku

Configuration
~~~~~~~~~~~~~

Enable XML RPC on your DokuWiki instance:
:code:`Admin > Configuration Settings > Authentication`

Create a new file: :code:`$HOME/.doku.ini`

::

   [connection]
   domain = domain.name.tld
   username = your-username
   password = your-password
   ssl = true
   path = /

   [settings]
   indexpage = root
   diaryroot = diary

Example usage:
~~~~~~~~~~~~~~

::

    doku list
   [2019-01-06 09:29:03] playground:playground
   [2019-01-06 09:18:47] wiki:dokuwiki
   [2019-01-06 09:18:47] wiki:syntax
   [2019-01-06 09:18:47] wiki:welcome

   doku list --namespace :playground
   [2019-01-06 09:29:03] playground:playground

    doku edit wiki:welcome
   # this will open your $EDITOR
   # with the full content of the wiki page
   Document saved.

    doku cat playground:playground
   ====== PlayGround ======

    doku --help
   Usage: doku [OPTIONS] COMMAND [ARGS]...

   Options:
     --help  Show this message and exit.

   Commands:
     cat
     edit
     list
     search

Diary
~~~~~

With :code:`diary` commands, you can use your wiki as a diary (surprise).

The :code:`show` command will show you all your logs (today).

The :code:`log` command will open up your :code:`$EDITOR` and after save+quit,
it will append it for your diary page (today).

When you call log, doku will check all the path back and generates
content for the tree.

For example:

::

   # Today is 2019-02-21 and your index is configured to be 'root'
   doku diary log

   # This will create the following pages if it's not exist
   :diary:2019:02:21
   :diary:2019:02:root
   :diary:2019:root

   # Will regenerate this page
   # if you log an entry in a year previously was not there
   :diary:root

   # from stdin (pipe)
   echo 'message' | doku diary log --pipe

   # decorate with <code>...</code>
   # automatically activated the --pipe flag
   ls -la | doku diary log --code