Skip to main content

Course material builder for online learning systems

Project description

build status download release

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, run roman. 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


Download files

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

Source Distribution

apluslms-roman-0.2.1rc4.tar.gz (8.6 kB view hashes)

Uploaded Source

Built Distribution

apluslms_roman-0.2.1rc4-py3-none-any.whl (12.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page