Ricecooker API reference

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

• Nodes
  • Overview
  • Content node metadata
  • Topic nodes
  • Content nodes
  • Exercise nodes
  • Legacy / advanced node classes
• Files
  • File objects
  • Base classes
  • Subtitle files
  • Legacy / advanced: constructing file objects directly
  • File size limits
• HTML5 Apps
  • Technical specifications
  • HTML5AppNode examples
  • Extracting Web Content
  • Usability guidelines
  • Using Local Kolibri Preview
  • Creating a HTMLZipFile
  • Further reading
• Exercises
  • QTI packages
  • Further reading
• Kolibri Language Codes
  • More lookup helper methods
• Running chef scripts
  • Ricecooker CLI
  • Using Python virtual env
  • Executable scripts
  • Long running tasks
• Running chefs on a remote box
  • Laptop setup
  • Box setup
  • Per-chef config
  • Running a chef
  • remote subcommands
• Migrating chefs from ricecooker 0.7 and 0.8
  • Removed and changed APIs
  • Pass node arguments by keyword
  • ricecooker.utils.utils was split

Code examples

• See the examples directory on GitHub full code examples.

• See the examples page for literate code examples that explain how to do specific tasks (find language codes, download subtitles, and exercises questions, etc). These examples are available as runnable Jupyter notebooks so you can try things out interactively and learn.

• See the Cheffing techniques doc which provides links to tips and code examples for handling various special cases and content sources.