Cookiecutter Girder Plugin
Install the Cookiecutter package:
pip install cookiecutter
Generate your project:
A name or brief description of the plugin. This is the name that will be displayed to users on Girder's plugin page.
The python package and directory name containing your plugin. This is the directory that will be created by this template. By python convention, this name should be in kebab-case. Many Girder plugins use the prefix
girder-to indicate they are Girder plugins. In addition, if you intend to distribute this package, you should ensure the name is available on PyPI.
The python module name containing your plugin. By python convention, this should be the same as the
package_namebut in snake_case. This must be a valid python variable name containing only letters, numbers, and underscores.
This is the name used internally by Girder to reference your plugin. By Girder's convention, this should the same as
girder_prefix. For example, the plugin
girder-jobsuses the entrypoint name
A short description of your plugin. This text will be added to the python package metadata and displayed to users on Girder's plugin page.
A URL that will be added to the package metadata. This is often the git repository or a link to documentation.
Include boilerplate for extending Girder's web client.