Cookiecutter Kolibri Plugin

Minimal Cookiecutter template for generating Kolibri plugins.

Usage

• Install Cookiecutter.

  $ pip install cookiecutter

• Install le-utils.

  $ pip install le-utils

• Generate a new Kolibri plugin within the directory of your choice.

  $ cookiecutter https://github.com/learningequality/cookiecutter-kolibri-plugin

• Select a readable plugin name.

  e.g. Vector Video Player.

• You will then be prompted to enter a description, a repository url, and author details.

• If you would like to change the default pypi package name, you can modify it.

  Must be kolibri_lowercase_separated_by_underscores (ie. kolibri_vector_video_player).

• If you would like to change the default plugin Class name for the Javascript class, you can modify it.

  Must be UpperCamelCase. (ie. VectorVideoPlayer).

• Select if this is a frontend plugin (i.e. it will provide a Javascript module for frontend code)

• Select if this plugin will have its own page within the Django app - if you are creating an extension of existing functionality in Kolibri, this will not be the case - such as a content renderer plugin.

• Select if this plugin is a content renderer plugin, and what content kind and file extension it handles. If you are not creating a content renderer plugin, you may safely ignore these options.

• Install the newly generated plugin in Kolibri.

  $ pip install -e <LOCAL_PATH_TO_THE_PLUGIN_DIRECTORY>

• Enable the plugin on Kolibri.

  $ kolibri plugin <plugin_name> enable

• Restart the Kolibri server.

• If the plugin has its own page, you can test the plugin by visiting http://127.0.0.1:8000/<plugin_name>