Plugin that requires additional python modules

I'm toying with the idea of writing a python plugin that would make use of websockets, and as such would require the optional websocket-client and wsaccel modules that MacOS doesn't include by default. I'm wondering what the best way of dealing with this is. Testing if the module(s) are imported properly is easy enough:

Code: Select all

try:
  import websoket
  import wsaccel
  websockets_included = True
except:
  websockets_include = False


What I'm wondering is what would be the best way to report this to the user? Clearly a log message is one approach, but what about reporting this in the PluginConfig and/or Device dialogs, preventing devices from being created, etc? Are there any standard/suggested approaches to dealing with something like this?

Thanks,

-Bruce

[jay (support)]

Generally, we encourage plugins to include the modules they need. If the modules are pure python (no compiled C code for instance), then it's pretty simple to do (verify the license allows it). That way you know the modules are present and you don't need special logic to functionally disable the plugin.

The trick is to also get any requirements for the modules. So initially getting it done might take some time, but once you've got that worked out then it's great.

Thanks, Jay. Can you point me to . plugin that includes a custom module so I can see how it's done?

Thanks, Jay. Can you point me to . plugin that includes a custom module so I can see how it's done?

My Twilio plugin includes the Twilio library module. The MQTT Connector includes several additional modules.

Thanks, Jay. Can you point me to . plugin that includes a custom module so I can see how it's done?

My Twilio plugin includes the Twilio library module. The MQTT Connector includes several additional modules.

Awesome, thanks for the pointers!