Giter VIP home page Giter VIP logo

ricecooker's Introduction

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)

ricecooker's People

Contributors

antonio-cortes-perez avatar aronasorman avatar atkristijan avatar benjaoming avatar bjester avatar bkarnow avatar divad12 avatar dragondave avatar elaeon avatar indirectlylit avatar intelliant01 avatar ivanistheone avatar jamalex avatar jayoshih avatar kollivier avatar miraziz avatar nucleogenesis avatar radinamatic avatar ralphiee22 avatar richard-dinh avatar rtibbles avatar sairina avatar tonioc987 avatar wenyuzhang1992 avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.