innoConv

Converter for interactive educational content.

Please refer to the documentation for installation and usage.

Requirements

• Python >=3.7
• Pandoc

For Tikz support:

• LaTeX
• pdf2svg

Quickstart

# Install innoconv locally using pip
$ pip install --user innoconv
# Convert some content
$ innoconv /path/to/content

Docker

The Docker image has all dependencies bundled and works out-of-the-box. It allows you to call the innoconv command inside a container.

$ docker run innodoc/innoconv --help

For passing content into and receiving the result from the container, you can use a volume.

$ cd /path/to/content
$ docker run \
  -v $(pwd):/content \
  -u $(id -u $USER) \
  innodoc/innoconv .

Development

tox

Development for innoConv relies on tox. It handles virtualenv creation, running linters and test suites across different Python versions and is also used in the CI pipeline.

Make sure to have it installed.

Commands

For an exhaustive list of commands please have a look at tox.ini.

Using the innoconv command (dev version)

Spawn a shell in a development environment.

$ tox -e dev

Or directly start your current development version.

$ tox -e dev -- innoconv /path/to/content

Linting

Adhere to code style black and PEP8.

$ tox -e linters

Tests

Run unit and integration tests.

$ tox -e py310-unit,py310-integration

HTML coverage report

A coverage report will be created in ./htmlcov and served via HTTP.

$ tox -e py310-unit,cov-html,serve-cov

Documentation

After building you can find the documentation in docs/build/html and look at it using a browser.

$ tox -e docs,serve-docs