Skip to main content

doku

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

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: Admin > Configuration Settings > Authentication

Create a new file: $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 diary commands, you can use your wiki as a diary (surprise).

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

The log command will open up your $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

Metadata

Release files for doku 0.1.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for doku 0.1.8
File Size Uploaded Provenance Actions
doku-0.1.8.tar.gz 17.7 kB Without provenance Details for doku-0.1.8.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for doku 0.1.8
File Interpreter ABI Platform Actions
doku-0.1.8-py3-none-any.whl Python 3 none any Details for doku-0.1.8-py3-none-any.whl

Total release size: 37.4 kB

Release files / doku-0.1.8.tar.gz

Download URL doku-0.1.8.tar.gz
Size 17.7 kB
Tags Source
SHA-256 checksum
How to use checksums
bf55774d2d99a05b5413c9ac5c3d683ac569441f9d60346f670701e6c672a0d7
BLAKE2b-256 checksum
How to use checksums
081ef1f0abf5e0345c62a45042c0c13eccf3da867fe4d48907e222664d792461
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.9.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

Release files / doku-0.1.8-py3-none-any.whl

Download URL doku-0.1.8-py3-none-any.whl
Size 19.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4ebd1d7e981c3d759dce4e9d5db0e7678f7752e8592b8374ab5828f484f1bc38
BLAKE2b-256 checksum
How to use checksums
684bb92acc3141b4aebc58d6acebf65e5df524cf53b1b20847d6258020c3bcb1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.9.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

Security for doku 0.1.8

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page