Welcome to the ricecooker docs!

Quickstart

Developers who are new to the ricecooker library can get started here.

• README
• Tutorial

Kolibri content platform

The Kolibri content platform is described in the following docs, which should be accessible to both technical and non-technical audiences.

• Kolibri content platform
• Supported content types

Ricecooker API reference

The detailed information for content developers (chef authors) is presented here:

• Using the ricecooker library
  • Step 1: Obtain a Studio Authorization Token
  • Step 2: Create a Sushi Chef script
  • Step 3: Add more content nodes and files
  • Step 4: Adding exercises
• Nodes
  • Overview
  • Content node metadata
  • Topic nodes
  • Content nodes
  • Exercise nodes
• Files
  • File objects
  • Base classes
  • Audio files
  • Document files
  • HTMLZip files
  • Videos files
  • Thumbnail files
  • File size limits
• Kolibri Language Codes
  • More lookup helper methods
• HTML5App nodes and HTML5Zip files
  • Example of HTML5App nodes
  • Usability guidelines
  • Links and navigation
  • HTML Writer utility class
  • Static assets download utility
  • Starter template
• Exercise and exercise questions
• Installation
  • Software prerequisites
  • Stable release
  • Install from github
  • Install from source
• Running chef scripts
  • Executable scripts
  • Ricecooker CLI
  • Run scripts
  • Daemon mode

Ricecooker Utils

The ricecooker library includes a number of utilities and helper functions:

• Parsing HTML using BeautifulSoup
• CSV Metadata Workflow
• CSV Exercises Workflow
• Writing a SousChef

Ricecooker developer docs

To learn about the inner workings of the ricecooker library, consult the following:

• Notes for ricecooker library developers
• Running chef scripts
• Daemon mode
• SushOps
• Command line interface
• Contributing
• Credits
• Ricecooker Python API
• History

Indices and tables

• Index
• Module Index
• Search Page