budosystems.models.style.Curriculum

class Curriculum

Bases: BasicInfo

Represents the training curriculum.

For studios that have their students progress in rank based on specific requirements.

style: Style

The style for which this curriculum applies.

requirement_schema: dict[str, str]

An ordered dictionary of (tag: label), used for organizing requirements within the rank.

The key (tag) is intended to be for internal purposes only. The value (label) is intended to be public facing.

property lowest_rank: Rank

Returns the lowest rank in the curriculum.

Returns:

The lowest rank of this curriculum.

add_rank(rank: Rank) → None

Adds a rank to this curriculum.

Parameters:

rank – The rank to be added.

remove_rank(rank: Rank) → None

Removes a rank from this curriculum.

Parameters:

rank – The rank to be removed.

clone(equivalent_ranks: bool = False) → Curriculum

Creates a deep copy of this curriculum including it ranks. If equivalent_ranks is True, then create an equivalence mapping.

Parameters:

equivalent_ranks – Whether to create an equivalence relationship between the ranks of this curriculum and those of the clone.

Returns:

A clone of this curriculum.

__init__(*, entity_id: UUID = <singleton MissingUUID>, name: str, slug: str, description: str = '', id_name: str = _Nothing.NOTHING, style: Style, requirement_schema: dict[str, str] = _Nothing.NOTHING) → None

Method generated by attrs for class Curriculum.