galaxy.tours package

galaxy.tours.build_tours_registry(tour_directories: str)[source]

class galaxy.tours.ToursRegistry[source]

Bases: ABC

abstract get_tours() → TourList[source]: Return list of tours.

abstract tour_contents(tour_id: str) → TourDetails[source]: Return tour contents.

abstract load_tour(tour_id: str) → TourDetails[source]: Reload tour and return its contents.

class galaxy.tours.Tour(*, name: str, description: str, tags: List[str], requirements: List[Requirement], id: str)[source]

Bases: TourCore

id: str

model_config: ClassVar[ConfigDict] = {'use_enum_values': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.tours.TourCore(*, name: str, description: str, tags: List[str], requirements: List[Requirement])[source]

Bases: BaseModel

name: str

description: str

tags: List[str]

requirements: List[Requirement]

model_config: ClassVar[ConfigDict] = {'use_enum_values': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.tours.TourDetails(*, name: str, description: str, tags: List[str], requirements: List[Requirement], title_default: str | None = None, steps: List[TourStep])[source]

Bases: TourCore

title_default: str | None

steps: List[TourStep]

model_config: ClassVar[ConfigDict] = {'use_enum_values': True}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class galaxy.tours.TourList(root: RootModelRootType = PydanticUndefined)[source]

Bases: RootModel

root: List[Tour]

model_config: ClassVar[ConfigDict] = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Bases: BaseModel

title: str | None

content: str | None

element: str | None

placement: str | None

preclick: bool | List[str] | None

postclick: bool | List[str] | None

textinsert: str | None

model_config: ClassVar[ConfigDict] = {}: Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Submodules

galaxy.tours.validate module

galaxy.tours.validate.main(argv=None)[source]