bilbo

Documentation Status Coverage Status

A python package and command-line tools to help build and maintain a gollum wiki.

Here’s a summary of what’s included in the python package:

Classes

bilbo.blog Take pages that have been flagged to be posted as a Jekyll blog post, format them correctly and post them
bilbo.scaffold Generate and maintain all of the scaffolding for gollum – blogging workflow, listings, tag page etc
bilbo.tasks Add projects from wikis to taskpaper files to keep track of project tasks
bilbo.templates Add template files and folders into new Gollum wiki projects and directories
bilbo.tidy Tidy up gollum wiki(s) by cleaning filenames, removing cruft, fixing metadata etc

Functions

bilbo.cl_utils.tab_complete

Installation

The easiest way to install bilbo is to use pip:

pip install bilbo

Or you can clone the github repo and install from a local version of the code:

git clone git@github.com:thespacedoctor/bilbo.git
cd bilbo
python setup.py install

To upgrade to the latest version of bilbo use the command:

pip install bilbo --upgrade

Development

If you want to tinker with the code, then install in development mode. This means you can modify the code from your cloned repo:

git clone git@github.com:thespacedoctor/bilbo.git
cd bilbo
python setup.py develop

Pull requests are welcomed!

Issues

Please report any issues here.

Command-Line Usage

Documentation for bilbo can be found here: http://bilbo.readthedocs.org/en/stable

Usage:
    bilbo template [-s <pathToSettingsFile>]
    bilbo tasks [-s <pathToSettingsFile>]
    bilbo tidy [-s <pathToSettingsFile>]
    bilbo scaffold [-s <pathToSettingsFile>]
    bilbo blog [-s <pathToSettingsFile>]

    COMMANDS
    ========
    template              populate the wiki with template content and cleanup file names
    tasks                 add projects from wikis to taskpaper files to keep track of project tasks
    tidy                  tidy up the gollum wiki, updating lists, sidebars, footer, headers, cleaning filenames and md metadata
    scaffold              add and maintain sidebars, footers, headers and various listing pages in a gollum wiki
    blog                  take pages that have been flagged to be posted as a Jekyll blog post, format them correctly and post them

    OPTIONS
    =======
    -h, --help            show this help message
    -s, --settings        the settings file

Documentation

Documentation for bilbo is hosted by Read the Docs (last stable version and latest version).