This document is for an in-development version of Galaxy. You can alternatively view this page in the latest release if it exists or view the top of the latest release's documentation.

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
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]
class Config[source]

Bases: object

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

Bases: TourCore

title_default: Optional[str]
steps: List[TourStep]
class galaxy.tours.TourList(*, __root__: List[Tour] = [])[source]

Bases: BaseModel

class galaxy.tours.TourStep(*, title: Optional[str] = None, content: Optional[str] = None, element: Optional[str] = None, placement: Optional[str] = None, preclick: Optional[Union[bool, List[str]]] = None, postclick: Optional[Union[bool, List[str]]] = None, textinsert: Optional[str] = None)[source]

Bases: BaseModel

title: Optional[str]
content: Optional[str]
element: Optional[str]
placement: Optional[str]
preclick: Optional[Union[bool, List[str]]]
postclick: Optional[Union[bool, List[str]]]
textinsert: Optional[str]


galaxy.tours.validate module