Converter for interactive educational content.
Project description
innoConv
Converter for interactive educational content.
Please refer to the documentation for installation and usage.
Quickstart
# Install innoconv locally using pip
$ pip install --user innoconv
# Convert some content
$ 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 a exhaustive list of commands please have a look at tox.ini
.
Using the innoconv command
Use the following to convert the base course.
$ git clone https://gitlab.tubit.tu-berlin.de/innodoc/tub_base.git
$ tox -e venv -- innoconv tub_base
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
. Look at it using a browser.
$ tox -e py37-unit,cov-html,serve-cov
Documentation
After building you can find the documentation in docs/build/html
.
$ tox -e docs
Serve the documentation to the browser for convenience.
$ tox -e 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.