create dedicated templates for custom apps and extensions

introduced functionnalities require pymodaq >= 4.3.0 for this template to fully work (at least for apps and extensiosn)

Author: seb5g

plugin_info.toml

@@ -13,7 +13,7 @@ license = 'MIT'
 
 [plugin-install]
 #packages required for your plugin:
-packages-required = ['pymodaq>=4.1.0']
+packages-required = ['pymodaq>=4.3.0']
 
 [features]  # defines the plugin features contained into this plugin
 instruments = true  # true if plugin contains instrument classes (else false, notice the lowercase for toml files)

src/pymodaq_plugins_template/app/custom_app_template.py

@@ -1,6 +1,8 @@
 from qtpy import QtWidgets
 
 from pymodaq.utils import gui_utils as gutils
+from pymodaq.utils.config import Config
+from pymodaq.utils.logger import set_logger, get_module_name
 
 # todo: replace here *pymodaq_plugins_template* by your plugin package name
 from pymodaq_plugins_template.utils import Config as PluginConfig

src/pymodaq_plugins_template/extensions/custom_extension_template.py

@@ -0,0 +1,130 @@
+from qtpy import QtWidgets
+
+from pymodaq.utils import gui_utils as gutils
+from pymodaq.utils.config import Config, get_set_preset_path
+from pymodaq.utils.logger import set_logger, get_module_name
+
+# todo: replace here *pymodaq_plugins_template* by your plugin package name
+from pymodaq_plugins_template.utils import Config as PluginConfig
+
+logger = set_logger(get_module_name(__file__))
+
+main_config = Config()
+plugin_config = PluginConfig()
+
+# todo: modify this as you wish
+EXTENSION_NAME = 'MY_EXTENSION_NAME'  # the name that will be displayed in the extension list in the
+# dashboard
+CLASS_NAME = 'CustomExtensionTemplate'  # this should be the name of your class defined below
+
+
+# todo: modify the name of this class to reflect its application and change the name in the main
+# method at the end of the script
+class CustomExtensionTemplate(gutils.CustomApp):
+
+    # todo: if you wish to create custom Parameter and corresponding widgets. These will be
+    # automatically added as children of self.settings. Morevover, the self.settings_tree will
+    # render the widgets in a Qtree. If you wish to see it in your app, add is into a Dock
+    params = []
+
+    def __init__(self, parent: gutils.DockArea, dashboard):
+        super().__init__(parent, dashboard)
+
+        # info: in an extension, if you want to interact with ControlModules you have to use the
+        # object: self.modules_manager which is a ModulesManager instance from the dashboard
+
+        self.setup_ui()
+
+    def setup_docks(self):
+        """Mandatory method to be subclassed to setup the docks layout
+
+        Examples
+        --------
+        >>>self.docks['ADock'] = gutils.Dock('ADock name')
+        >>>self.dockarea.addDock(self.docks['ADock'])
+        >>>self.docks['AnotherDock'] = gutils.Dock('AnotherDock name')
+        >>>self.dockarea.addDock(self.docks['AnotherDock'''], 'bottom', self.docks['ADock'])
+
+        See Also
+        --------
+        pyqtgraph.dockarea.Dock
+        """
+        # todo: create docks and add them here to hold your widgets
+        # reminder, the attribute self.settings_tree will  render the widgets in a Qtree.
+        # If you wish to see it in your app, add is into a Dock
+        raise NotImplementedError
+
+    def setup_actions(self):
+        """Method where to create actions to be subclassed. Mandatory
+
+        Examples
+        --------
+        >>> self.add_action('Quit', 'close2', "Quit program")
+        >>> self.add_action('Grab', 'camera', "Grab from camera", checkable=True)
+        >>> self.add_action('Load', 'Open', "Load target file (.h5, .png, .jpg) or data from camera"
+            , checkable=False)
+        >>> self.add_action('Save', 'SaveAs', "Save current data", checkable=False)
+
+        See Also
+        --------
+        ActionManager.add_action
+        """
+        raise NotImplementedError(f'You have to define actions here')
+
+    def connect_things(self):
+        """Connect actions and/or other widgets signal to methods"""
+        raise NotImplementedError
+
+    def setup_menu(self):
+        """Non mandatory method to be subclassed in order to create a menubar
+
+        create menu for actions contained into the self._actions, for instance:
+
+        Examples
+        --------
+        >>>file_menu = self.mainwindow.menuBar().addMenu('File')
+        >>>self.affect_to('load', file_menu)
+        >>>self.affect_to('save', file_menu)
+
+        >>>file_menu.addSeparator()
+        >>>self.affect_to('quit', file_menu)
+
+        See Also
+        --------
+        pymodaq.utils.managers.action_manager.ActionManager
+        """
+        # todo create and populate menu using actions defined above in self.setup_actions
+        pass
+
+    def value_changed(self, param):
+        """ Actions to perform when one of the param's value in self.settings is changed from the
+        user interface
+
+        For instance:
+        if param.name() == 'do_something':
+            if param.value():
+                print('Do something')
+                self.settings.child('main_settings', 'something_done').setValue(False)
+
+        Parameters
+        ----------
+        param: (Parameter) the parameter whose value just changed
+        """
+        pass
+
+
+def main():
+    from pymodaq.utils.gui_utils.utils import mkQApp
+    from pymodaq.utils.gui_utils.loader_utils import load_dashboard_with_preset
+
+
+    app = mkQApp(EXTENSION_NAME)
+    preset_file_name = plugin_config('presets', f'preset_for_{EXTENSION_NAME}')
+
+    load_dashboard_with_preset(preset_file_name, EXTENSION_NAME)
+
+    app.exec()
+
+
+if __name__ == '__main__':
+    main()