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 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 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 py38-unit,py38-integration
HTML coverage report
A coverage report will be created in ./htmlcov and served via HTTP.
$ tox -e py38-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
1 maintainer
Release files for innoconv 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| innoconv-0.1.3.tar.gz | 25.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| innoconv-0.1.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 63.1 kB
Release files / innoconv-0.1.3.tar.gz
| Download URL | innoconv-0.1.3.tar.gz |
|---|---|
| Size | 25.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
17eab0b37994352171fd8158d165c95a678edcf65fdd74eef74d7c9d47afabf8
|
|
BLAKE2b-256 checksum How to use checksums |
a0a1fdf39ea73ad5938ad21edfc1d834245575e71d9b50ba7a4d8c78015682f3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.3.3 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.0
|
Release files / innoconv-0.1.3-py3-none-any.whl
| Download URL | innoconv-0.1.3-py3-none-any.whl |
|---|---|
| Size | 37.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a46d517775f4096314136ad9088454bc9f4b48c15fea4b51445a6e447da835c0
|
|
BLAKE2b-256 checksum How to use checksums |
6f0f8c4b71e6c7e9d9fe4774128a2cace01fc54866af93c037058ddb421d5bd5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.3.3 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.0
|
