Plexora

Requirement

One thing a plugin needs that the project does not have yet.

Generated from Plexora 0.0.55View source
from plexora.api import Requirement

Also available as plexora.api.plugin.Requirement.

Requirement(key: str, kind: str, label: str, optional: bool = False)

Data rather than a message, because core renders it: the requirements modal turns a list of these into a form without knowing which plugin asked or what it wants them for. kind picks the input widget; key is what the answer is posted back under.

Fields

keystrrequired

What the answer is posted back under.

kindstrrequired

'data' | 'segmentation' | 'classification' | 'features' | 'role' | 'coordinates' -- selects which input widget the requirements modal shows.

labelstrrequired

Shown to the user next to the input widget.

optionalbooldefault False

Offered but not blocking -- the tool opens whether or not it is given.