Skip to content

Python library for creating Kolibri channels and uploading to Studio

License

Notifications You must be signed in to change notification settings

AllanOXDi/ricecooker

 
 

Repository files navigation

ricecooker

PyPI pyversions build docs

The ricecooker library is a framework for automating the conversion of educational content into Kolibri content channels and uploading them to Kolibri Studio, which is the central content server for Kolibri.

Visit the documentation site at 📚 ricecooker.readthedocs.io for the full details about installation, getting started, API reference, and code examples.

Overview of Kolibri content

ricecooker is used to take openly licensed educational content available on the web and convert it into an offline-friendly package that can be imported into Kolibri.

The basic process of getting new content into Kolibri is as follows:

  • UPLOAD your content to Kolibri Studio either manually through the Kolibri Studio web interface or programmatically using a ricecooker-based content integration script.
  • PUBLISH the channel on Kolibri Studio to make it accessible for use in Kolibri.
  • IMPORT the the channel into Kolibri using the channel token displayed in Kolibri Studio after the PUBLISH step is done.

The diagram below illustrates how content flows within the Kolibri ecosystem and highlights the part which is covered by the ricecooker framework (bottom left).

Overview of steps for integrating external content sources for use in the Kolibri Learning Platform External content sources (left) are first uploaded to Kolibri Studio (middle), so they can be used in the Kolibri Learning Platform (right).

Further reading

The Ricecooker docs website is the best place to learn about writing automated content integration scripts.

Here are some links to other documents and guides you can read to learn about the other parts of the Kolibri content platform:

  • The Kolibri Content Integration Guide is a comprehensive guide to the decisions, processes, and tools for integrating external content sources for use in the Kolibri Learning Platform.
  • Read the Kolibri Studio docs to learn more about the Kolibri Studio features
  • Read the Kolibri docs to learn how to install Kolibri on your machine (useful for testing channels)

About

Python library for creating Kolibri channels and uploading to Studio

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 99.0%
  • Other 1.0%