How to mark plugin incompatible with certain versions of Octoprint

shadycuz · July 3, 2021, 8:00am

The next release of my plugin relies on Octoprint >= 1.6.0 as it has a new feature that my plugin now requires.

I did lots of searching but I didn't really see anyway to prevent your plugin from being downloaded and installed if the user's Octoprint version was not compatible with the plugin.

Charlie_Powell · July 3, 2021, 8:13am

There's a number of ways that you can make it so that the plugin doesn't show up for users, doesn't install and doesn't load.

You can set the required version of OctoPrint in the plugin repository, under the compatibility data. This means that users without a compatible version will not be able to install it from the official repository.

Because people don't always read, they may want to install the plugin direct from a URL. To combat this you can test the requirements in your setup.py file by importing from octoprint.util.version to test compatibility:

github.com

OctoPrint/OctoPrint/blob/85f6fa0182fede2006f56c7d2f3e678858ef907e/src/octoprint/util/version.py#L83

    
      
          
          
    if not is_released_octoprint_version(version=version):
                  return False
          
          
    if isinstance(version, tuple):
                  return "*a" not in version and "*b" not in version and "*c" not in version
              else:
                  return not version.is_prerelease
          
          

          
def is_octoprint_compatible(*compatibility_entries, **kwargs):
              """
              Tests if the current ``octoprint_version`` is compatible to any of the provided ``compatibility_entries``.
          
          
    Arguments:
                      compatibility_entries (str): compatibility string(s) to test against, result will be `True` if any match
                              is found
                      octoprint_version (tuple or SetuptoolsVersion): optional OctoPrint version to match against, if not current
                              base version will be determined via :func:`get_octoprint_version`.
          
          
    Returns:

Finally, if you don't want to block the install, you can prevent loading by implementing a __plugin_check__ control property and doing the same test as above. Control Properties — OctoPrint master documentation

jneilliii · July 4, 2021, 5:17am

You can also do a staged/branch approach and allow older version to be locked from updates to a compatible version octoprint. I've got the first stage for this completed on one of my plugins. Next release will only go to octoprint 1.6.0 or newer, similar to what you need.