Template for making plug-ins for the Python-Microscopy Environment (PYME)
pyme-plugin/package_name
. pyme-plugin/package_name
directory.plugins
directory, go into the dsviewer
, recipes
, and visgui
folders and edit
package_name.txt
to include your actual package name, and to point to each of your module files with a new line. For example, two dsviewer module files could have a package_name.txt
file of:
mynewpackage.dsviewer_modules.my_core_functions
mynewpackage.dsviewer_modules.my_other_dsview_modules
package_name.txt
files to match your package.setup.py
to include your package name, version, and description.python setup.py develop
or python setup.py develop
from the top directory. This will install your package and run the post-install script (install_plugin.py
) to register the plugin with PYME. Any additional configuration you would like to be automatic for users on install (e.g. a GUI pop up) can be added to that script.