This is a cookiecutter for getting started with Tutor plugins. It will generate a base scaffold for an empty tutor plugin that does, well, nothing.

pip install -U cookiecutter

cookiecutter https://github.com/overhangio/cookiecutter-tutor-plugin.git

Please keep the "contrib" part in your generated package name to differentiate from official plugins.

Once you have generated your plugin, you can start using it right away (even if it won't do anything)

pip install -e ./tutor-contrib-myplugin
tutor plugins list  # Your plugin should appear here
tutor plugins enable myplugin  # Have fun!

The plugin API was upgraded from v0 to v1 in Tutor v13.2.0. This cookiecutter generates plugin scaffolds for v1. The v0 API will be supported for some time, but you are encouraged to upgrade your plugins. To upgrade a v0 plugin that was generated previously with this cookiecutter, please follow the instructions in the Migrating from v0 plugins section.

This Tutor plugin template is maintained by Emad Rad from edSPIRIT. Community support is available from the official Open edX forum.

Do you need help using this template? See the troubleshooting section from the Tutor documentation.

Pull requests are welcome! Please read the "contributing" section from the Tutor documentation.

Unlike other Tutor repositories, you do not need to run make changelog-entry. Instead, simply edit CHANGELOG.md to note any changes that might affect plugin developers using the cookiecutter.

This software is licensed under the terms of the AGPLv3.