Plugin Templates
Pymemri offers a range of plugin templates to set up testing, docker and CI for you. This way, you can focus on building your plugin, and be sure it works within the Memri ecosystem.
All plugins are hosted on our GitLab. In order to make your own plugin from a template,
- Create an account on GitLab
- Create a public blank repository
- Clone the repository
- run the
plugin_from_template
CLI inside the repository folder.
The CLI will infer most settings for you from your git account and repository name, only a template name and optional description are required.
plugin_from_template --template classifier_plugin --description "My Classifier Plugin"
To make sure all settings are correct, you can inspect metadata.json
, which holds all information like your plugin name, and python package name.
You can list the available templates with. All plugin templates are hosted here.
plugin_from_template --list
The CLI has options to customize the plugin name, package name and other aspects of your plugin. For advanced use, run:
plugin_from_template --help
With the plugin_from_template
CLI, you can easily create a plugin where all CI pipelines, docker files, and test setups are configured for you. Multiple templates are available, to see the complete list use:
plugin_from_template --list_templates
!plugin_from_template --list_templates