Welcome to microdrop-plugin-template’s documentation!¶
Template for a Microdrop plugin.
Create a new plugin¶
Initialize new plugin from template:
python -m microdrop_plugin_template.create_plugin <output directory>
For full usage details, run:
python -m microdrop_plugin_template.create_plugin --help
Copy hook scripts to existing plugin directory¶
If the hook scripts copied during the initialization of a new plugin
have not been modified, it may be beneficial to update the hook scripts
to match the ones in the latest version of the
microdrop-plugin-template
plugin template.
To copy the latest version of the hook scripts from the
microdrop-plugin-template
plugin template to an existing plugin
directory, run:
python -m microdrop_plugin_template.init_hooks <plugin directory>
For full usage details, run:
python -m microdrop_plugin_template.init_hooks --help
API reference¶
-
microdrop_plugin_template.create_plugin.
create_plugin
(output_directory, overwrite=False, init_git=True)[source]¶ Parameters: Returns: Output directory path.
Return type: path_helpers.path
Raises: ValueError
– If output_directory name is not a valid Python module name.IOError
– If output_directory exists and overwrite isFalse
.
-
microdrop_plugin_template.create_plugin.
parse_args
(args=None)[source]¶ Parses arguments, returns
(options, args)
.