Course material builder for online learning systems
Project description
Roman is course material builder for A+ and other learning management systems.
Roman uses docker to run different build steps.
Course building steps are configure in course.yml
, which is read by roman.
Roman is in experimental development state
Check out Ariel
.
It is an extension to sphinx build process that is used to build RST course material to HTML and YAML files.
It can simple be used by adding apluslms/ariel
to build steps.
Course configuration
Roman reads configuration file course.yml
, course.yaml
or course.json
and then
runs course build steps defined in steps
list.
Steps can be strings describing docker image or objects containing at least img
.
Here is small example:
# course.yml
---
version: 2
theme: aplus
steps:
- hello-world
- img: apluslms/compile-rst
cmd: make touchrst html
mnt: /compile
env:
STATIC_CONTENT_HOST: "http://localhost:8080/static/default"
Installation
You can use prebuild binaries with graphical user inteface from releases page.
Alternatively, you can install cli version via pip pip install apluslms-roman
(will add roman
command).
List of graphical user inteface binaries
*-linux.AppImage
is an AppImage package of Roman. Download, mark file executable and run it. Requires FUSE (installed on typical linux desktop).*-linux.zip
contains a single-file executable. Download, extract, runroman
. Requires that files in/tmp/
can be executed.*-mac.dmg
contains Roman.app in a disk image. Download, open, drag Roman.app to e.g. Applications, run. Note: On the first time you need to right or control-click the app, select open in the menu and finally open in the dialog.*-mac.zip
contains Roman.app in a zip. Same prosess as with above version.
If you are not sure what file to use, then use the first one for your operating system.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for apluslms_roman-0.2.1rc4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e455c07531476cbcfe0709e3c6408c3b3e129a6ccdbb5e32561cdf62eea4184f |
|
MD5 | 2caf347090f6faa688bd2368f2c9f79a |
|
BLAKE2b-256 | 8f17aa27d9e53bc133f109d5d1d39e5c2fe0ea8c0791cc9e3264d30c5a36ce77 |