gxformat2.examples package

Module contents

Galaxy workflow examples shipped with gxformat2 for testing and downstream use.

class gxformat2.examples.CatalogEntry(*, file: str, origin: ExampleOrigin, format: ExampleFormat, tests: list[str])

Bases: BaseModel

Metadata for an example workflow in the catalog.

file: str

format: ExampleFormat

load() → dict

Load and parse the workflow file.

load_contents() → str

Return raw file contents.

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

property name: str

Filename without directory prefix.

origin: ExampleOrigin

property path: str

Absolute path to the workflow file.

tests: list[str]

property workflow_annotation: str | None

Workflow doc or annotation extracted from the file.

property workflow_label: str | None

Workflow label or name extracted from the file.

class gxformat2.examples.ExampleFormat(*values)

Bases: str, Enum

Galaxy workflow serialization format.

format2 = 'format2'

native = 'native'

class gxformat2.examples.ExampleOrigin(*values)

Bases: str, Enum

How the workflow was produced.

converted = 'converted'

real = 'real'

real_hacked = 'real-hacked'

synthetic = 'synthetic'

gxformat2.examples.get_path(name: str) → str

Return absolute path to an example workflow file by name (with extension).

gxformat2.examples.load(name: str) → dict

Load and parse an example workflow by name.

gxformat2.examples.load_catalog() → list[CatalogEntry]

Load and validate the example workflow catalog.

gxformat2.examples.load_contents(name: str) → str

Return raw file contents of an example workflow by name.