Getting started

Prerequisites

innoConv is mainly used on Linux machines. It might work on Mac OS and Windows/Cygwin/WSL. You are invited to share your experiences.

Dependencies

The only dependencies you have to provide yourself is Pandoc and the Python interpreter.

Python 3

innoConv is being tested and developed with Python 3.4-3.7.

Python should be available on the majority of Linux machines nowadays. Usually it’s being installed using a package manager.

Pandoc

You need to make sure to have a recent version of the pandoc binary available in $PATH (version 2.7 at the time of writing). There are several ways how to install Pandoc.

Installation

Using pip

The easiest way to install innoConv is to use pip.

Given you have a regular Python setup with pip available the following installs innoConv in your user directory (usually ~/.local under Linux).

$ pip install --user innoconv

For the innoconv command to work, make sure you have ~/.local/bin in your $PATH.

For a system-wide installation you can omit the --user argument.

$ pip install innoconv

In a virtual environment

It’s possible to install innoConv into a virtual environment. Setup and activate a virtual environment in a location of your choice.

$ python3 -m venv /path/to/venv
$ source /path/to/venv/bin/activate

Install innoConv in your virtual environment using pip.

$ pip install innoconv

If everything went fine you should now have access to the innoconv command.

The next time you login to your shell make sure to activate your virtual environment before using innoconv.