erdantic.examples.pydantic

Example data model classes using Pydantic.

Classes

Adventurer pydantic-model

A person often late for dinner but with a tale or two to tell.

Attributes:

Name	Type	Description
name	str	Name of this adventurer
profession	str	Profession of this adventurer
level	int	Level of this adventurer
alignment	Alignment	Alignment of this adventurer

alignment: Alignment pydantic-field required

level: int pydantic-field required

name: str pydantic-field required

profession: str pydantic-field required

Alignment

An enumeration.

CHAOTIC_EVIL

CHAOTIC_GOOD

CHAOTIC_NEUTRAL

LAWFUL_EVIL

LAWFUL_GOOD

LAWFUL_NEUTRAL

NEUTRAL_EVIL

NEUTRAL_GOOD

TRUE_NEUTRAL

Party pydantic-model

A group of adventurers finding themselves doing and saying things altogether unexpected.

Attributes:

Name	Type	Description
name	str	Name that party is known by
formed_datetime	datetime	Timestamp of when the party was formed
members	List[Adventurer]	Adventurers that belong to this party
active_quest	Optional[Quest]	Current quest that party is actively tackling

active_quest: Quest pydantic-field

formed_datetime: datetime pydantic-field required

members: List[erdantic.examples.pydantic.Adventurer] pydantic-field required

name: str pydantic-field required

Quest pydantic-model

A task to complete, with some monetary reward.

Attributes:

Name	Type	Description
name	str	Name by which this quest is referred to
giver	QuestGiver	Person who offered the quest
reward_gold	int	Amount of gold to be rewarded for quest completion

giver: QuestGiver pydantic-field required

name: str pydantic-field required

reward_gold: int pydantic-field required

QuestGiver pydantic-model

A person who offers a task that needs completing.

Attributes:

Name	Type	Description
name	str	Name of this quest giver
faction	str	Faction that this quest giver belongs to
location	str	Location this quest giver can be found

faction: str pydantic-field

location: str pydantic-field required

name: str pydantic-field required