Kolibri is an open source educational platform to distribute content to areas with little or no internet connectivity. Educational content is created and edited on Kolibri Studio, which is a platform for organizing content to import from the Kolibri applications. The purpose of this project is to create a chef, or a program that scrapes a content source and puts it into a format that can be imported into Kolibri Studio.
Install Python 3 if you don't have it already.
Install pip if you don't have it already.
Create a Python virtual environment for this project (optional, but recommended):
pip install virtualenv
venv
in the current directory using the
following command: virtualenv -p python3 venv
venv
by running: source venv/bin/activate
.
Your command prompt will change to indicate you're working inside venv
.venv
in the current directory using the
following command: virtualenv -p C:/Python36/python.exe venv
.
You may need to adjust the -p
argument depending on where your version
of Python is located.venv
by running: .\venv\Scripts\activate
Run pip install -r requirements.txt
to install the required python libraries.
TODO: Explain how to run the Hsoub Academy chef
export SOMEVAR=someval
./script.py -v --option2 --kwoard="val"
A sushi chef script is responsible for importing content into Kolibri Studio. The Rice Cooker library provides all the necessary methods for uploading the channel content to Kolibri Studio, as well as helper functions and utilities.
A sushi chef script has been started for you in sushichef.py
.
Sushi chef docs can be found here.
_For more sushi chef examples, see examples/openstax_sushichef.py
(json) and
examples/wikipedia_sushichef.py
(html) and also the examples/ dir inside the ricecooker repo._
Please make sure your final chef matches the following standards.
source_id
s determined consistently (based on foreign database identifiers or permanent url paths)?if
or for
loops?path
vs p
)?