Skip to main content

Converter for interactive educational content.

Project description

build status coverage report Documentation Status

innoConv

Converter for interactive educational content.

Please refer to the documentation for installation and usage.

Requirements

For Tikz support:

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 a useful conversion you have to share your content and output folder between host and container. Also make sure to set the user ID and use the --force flag.

$ docker run \
  -v $(pwd)/innoconv_output:/output \
  -v $(pwd)/tub_base:/content:ro \
  -u `id -u $USER` \
  innodoc/innoconv \
    --force \
    --output-dir /output \
    /content

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 shell

Or directly start your current development version.

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

Linting

Adhere to code style black and PEP8.

$ tox -e linters

Tests

Run unit and integration tests.

$ tox -e py37-unit,py37-integration

HTML coverage report

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

$ tox -e py37-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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
innoconv-0.0.4-py3-none-any.whl (31.8 kB) Copy SHA256 hash SHA256 Wheel py3
innoconv-0.0.4.tar.gz (19.7 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page