https://github.com/mitodl/xbundle

xbundle tool for edX courses
https://github.com/mitodl/xbundle

Last synced: 6 days ago
JSON representation

xbundle tool for edX courses

• Host: GitHub
• URL: https://github.com/mitodl/xbundle
• Owner: mitodl
• License: other
• Created: 2013-06-08T03:41:41.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2023-10-20T13:38:09.000Z (about 1 year ago)
• Last Synced: 2024-09-09T14:21:19.786Z (4 months ago)
• Language: JavaScript
• Size: 836 KB
• Stars: 1
• Watchers: 32
• Forks: 5
• Open Issues: 11
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
xbundle

=======

.. image:: https://travis-ci.org/mitodl/xbundle.svg?branch=travis

    :target: https://travis-ci.org/mitodl/xbundle

.. image:: https://coveralls.io/repos/mitodl/xbundle/badge.svg?branch=master&service=github

    :target: https://coveralls.io/github/mitodl/xbundle?branch=master             

``xbundle`` converts back and forth between OLX and "xbundle" style XML

formats. The xbundle format is a single XML file.

The OLX format is defined in `this

documentation `__.

Installation

------------

``python setup.py install``

This will install ``xbundle`` and the ``xbundle_convert`` command-line

tool.

--------------

Using xbundle in your code

--------------------------

To convert from xbundle to OLX

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: python

        from xbundle import XBundle

        bundle = XBundle()

        # get input_path and output_path from user input 

        bundle.load(input_path)

        bundle.export_to_directory(output_path)

To convert from OLX to xbundle

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code:: python

        from xbundle import XBundle

        bundle = XBundle()

        # get input_path and output_path from user input 

        bundle.import_from_directory(input_path)

        bundle.save(output_path)

--------------

Using the command-line tool

---------------------------

``xbundle_convert convert /path/to/course /path/to/output.xml``

or

``xbundle_convert convert /path/to/output.xml /path/to/course``

--------------

Run tests

---------

``xbundle_convert test``