Skip to main content

Utilities for edX OLX courses

Project description

PyPI version Build Status codecov

OLX Utilities

A set of tools to facilitate courseware development using the Open Learning XML (OLX) format.

OLX is sometimes tediously repetitive, and this package enables courseware authors to apply the DRY principle when writing OLX content. It allows you to create templates (using Mako), which in turn enable you to

  • define OLX fragments only once, to reuse them as often as you want (this comes in very handy in using the hastexo XBlock),
  • write courseware content in Markdown,
  • do anything else you would like to do using your own plugins.

Install

Install the olx-utils package from PyPI:

pip install olx-utils

Apply templates to a course

In order to create a new course run named newrun, starting on May 1, 2017 and ending on October 31, 2017, simply change into your courseware checkout and run:

olx new-run -b newrun 2019-01-01 2019-12-31

The -b option causes your rendered OLX to be added to a new Git branch named run/newrun, which you can then import into your Open edX content store.

You can also invoke olx new-run as new_run.py. However, this is deprecated and its use is discouraged. new_run.py will go away in a future release.

License

This package is licensed under the GNU Affero GPL; see LICENSE for details.

Project details


Download files

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

Files for olx-utils, version 0.3.1
Filename, size File type Python version Upload date Hashes
Filename, size olx-utils-0.3.1.tar.gz (501.5 kB) File type Source Python version None Upload date Hashes View hashes

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