new plugin feature layout

plugin_info.toml

@@ -10,3 +10,11 @@ author-email = '[email protected]'
 [plugin-install]
 #packages required for your plugin:
 packages-required = ['pymodaq>4.0.0'] #list of required packages within quotes, eg: ["pyvisa", "numpy==1.19.3"] ...
+
+[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)
+extensions = false  # true if plugins contains dashboard extensions
+pid_models = false  # true if plugins contains pid models
+h5exporters = false  # true if plugin contains custom h5 file exporters
+scanners = false  # true if plugin contains custom scan layout (daq_scan extensions)
+

setup.py

@@ -37,13 +37,27 @@
     ], )
 
 
+entrypoints = {}
+if 'features' in config:
+    if config['features'].get('instruments', False):
+        entrypoints['pymodaq.instruments'] = f'{SHORT_PLUGIN_NAME} = {PLUGIN_NAME}'
+    if config['features'].get('extensions', False):
+        entrypoints['pymodaq.extensions'] = f'{SHORT_PLUGIN_NAME} = {PLUGIN_NAME}'
+    if config['features'].get('pid_models', False):
+        entrypoints['pymodaq.pid_models'] = f'{SHORT_PLUGIN_NAME} = {PLUGIN_NAME}'
+    if config['features'].get('h5exporters', False):
+        entrypoints['pymodaq.h5exporters'] = f'{SHORT_PLUGIN_NAME} = {PLUGIN_NAME}'
+    if config['features'].get('scanners', False):
+        entrypoints['pymodaq.scanners'] = f'{SHORT_PLUGIN_NAME} = {PLUGIN_NAME}'
+else:
+    entrypoints['pymodaq.instruments'] = f'{SHORT_PLUGIN_NAME} = {PLUGIN_NAME}'
+
 setup(
     version=version,
     packages=find_packages(where='./src'),
     package_dir={'': 'src'},
     include_package_data=True,
-    entry_points={'pymodaq.plugins': f'{SHORT_PLUGIN_NAME} = {PLUGIN_NAME}',
-                  'pymodaq.pid_models': f"{SHORT_PLUGIN_NAME} = {PLUGIN_NAME}"},
+    entry_points=entrypoints,
     install_requires=['toml', ]+config['plugin-install']['packages-required'],
     **setupOpts
 )

src/pymodaq_plugins_teaching/resources/config_template.toml

@@ -0,0 +1,2 @@
+#this is the configuration file of the plugin
+

src/pymodaq_plugins_teaching/utils.py

@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+"""
+Created the 31/08/2023
+
+@author: Sebastien Weber
+"""
+from pathlib import Path
+
+from pymodaq.utils.config import BaseConfig, USER
+
+
+class Config(BaseConfig):
+    """Main class to deal with configuration values for this plugin"""
+    config_template_path = Path(__file__).parent.joinpath('resources/config_template.toml')
+    config_name = f"config_{__package__.split('pymodaq_plugins_')[1]}"

tests/test_plugin_package_structure.py

@@ -51,14 +51,13 @@ def test_imports():
     mod = importlib.import_module(pkg_name)
     assert hasattr(mod, 'config')
     assert hasattr(mod, '__version__')
-    move_mod = importlib.import_module(f'{pkg_name}', 'daq_move_plugins')
+    importlib.import_module(f'{pkg_name}', 'daq_move_plugins')
     importlib.import_module(f'{pkg_name}', 'daq_viewer_plugins')
     importlib.import_module(f'{pkg_name}', 'extensions')
     importlib.import_module(f'{pkg_name}', 'models')
     importlib.import_module(f'{pkg_name}.daq_viewer_plugins', 'plugins_0D')
     importlib.import_module(f'{pkg_name}.daq_viewer_plugins', 'plugins_1D')
     importlib.import_module(f'{pkg_name}.daq_viewer_plugins', 'plugins_2D')
-    importlib.import_module(f'{pkg_name}.daq_viewer_plugins', 'plugins_ND')
 
 
 def test_move_inst_plugins_name():
@@ -85,7 +84,7 @@ def test_move_has_mandatory_methods():
             assert hasattr(klass, meth)
 
 
-@pytest.mark.parametrize('dim', ('0D', '1D', '2D', 'ND'))
+@pytest.mark.parametrize('dim', ('0D', '1D', '2D'))
 def test_viewer_has_mandatory_methods(dim):
     plugin_list, mod = get_viewer_plugins(dim)
     for plug in plugin_list: