Converter for interactive educational content.
Please refer to the documentation for installation and usage.
For Tikz support:
# Install innoconv locally using pip
$ pip install --user innoconv
# Convert some content
$ innoconv /path/to/content
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 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.
For an exhaustive list of commands please have a look at tox.ini
.
Spawn a shell in a development environment.
$ tox -e dev
Or directly start your current development version.
$ tox -e dev -- innoconv /path/to/content
Adhere to code style black and PEP8.
$ tox -e linters
Run unit and integration tests.
$ tox -e py310-unit,py310-integration
A coverage report will be created in ./htmlcov
and served via HTTP.
$ tox -e py310-unit,cov-html,serve-cov
After building you can find the documentation in docs/build/html
and look at
it using a browser.
$ tox -e docs,serve-docs