Installation and Operation

Installation

The kppe.py file and associated other files in the repo should be placed in a suitable location. For convenience, it is helpful to place this location in your system’s path.

Operation

kppe.py should be invoked on the command line, giving it the template to use and the pandoc text file to generate a PDF from. Help is available with the -h switch:

kppe.py -h:

usage: kppe.py [-h] {build,templates} ...

Build a PDF with markdown2pdf

positional arguments:
  {build,templates}
    build            Build a PDF from the supplied file
    templates        Print a list of templates from the config file

optional arguments:
  -h, --help         show this help message and exit

kppe.py build -h:

usage: kppe.py build [-h] [--write_source_file] [--toc]
                     [--config_file CONFIG_FILE] [--quiet] [--version]
                     template file

positional arguments:
  template              Select a template to use
  file                  The pandoc file to process

optional arguments:
  -h, --help            show this help message and exit
  --write_source_file   Whether to save the generated source file. If set, the
                        file is saved to output.txt
  --toc                 Also generate a table of contents
  --config_file CONFIG_FILE
                        Set the full path to the config file to use. Defaults
                        to "config.ini"
  --quiet, -q           Whether to suppress information and status during
                        operation
  --version             show program's version number and exit

kppe.py templates -h:

usage: kppe.py templates [-h] [--config_file CONFIG_FILE] [--quiet]
                         [--version]

optional arguments:
  -h, --help            show this help message and exit
  --config_file CONFIG_FILE
                        Set the full path to the config file to use. Defaults
                        to "config.ini"
  --quiet, -q           Whether to suppress information and status during
                        operation
  --version             show program's version number and exit