Write a Rodan job package

The job packages reside in the folder /rodan/jobs/. A job vendor provides its directory under this folder, where multiple Rodan jobs are defined. A job vendor can define the resource types that are required for its jobs as well.

Define a Rodan job

A Rodan job is defined by a class that inherits rodan.jobs.base.RodanTask. The class should define the following attributes as its description:

• name: [string] a unique name within all the jobs provided by the vendor.
• author: [string] the author of the job.
• description: [string]
• settings: [JSON Schema]¹ the validation schema that describes the requirements of the job settings.
• enabled: [boolean]
• category: [string]
• interactive: [boolean] indicates whether the job will pause at some point and wait for manual input.²
• input_port_types: [list of dict] each dictionary should include the following keys:
  • name: [string]
  • resource_types: [list of string | lambda: string -> boolean] describes all possible resource MIME-types. If provided with a lambda function, Rodan will automatically filter the matched resource types in its registry.
  • minimum: [number] minimum requirement of the job. 0 indicates no minimum requirement.
  • maximum: [number] maximum requirement of the job. 0 indicates no maximum requirement.
• output_port_types: [list of dict] the same as input_port_types.

1 - At present, Rodan only supports a JSON object as the topmost structure of settings. 2 - It is only informative for the users. It does not affect whether the job will pause. The behaviour of the job is determined by the return value of its execution code.