Skip to content

kiara.metadata.core_models

AuthorModel pydantic-model

email: EmailStr pydantic-field

The email address of the author

name: str pydantic-field required

The full name of the author.

ContextMetadataModel pydantic-model

labels: Dict[str, str] pydantic-field

A list of labels for the item.

references: Dict[str, kiara.metadata.core_models.LinkModel] pydantic-field

References for the item.

tags: Set[str] pydantic-field

A list of tags for the item.

DocumentationMetadataModel pydantic-model

description: str pydantic-field

Short description of the item.

doc: str pydantic-field

Detailed documentation of the item (in markdown).

LinkModel pydantic-model

desc: str pydantic-field

A short description of the link content.

url: AnyUrl pydantic-field required

The url.

MetadataModelMetadata pydantic-model

context: ContextMetadataModel pydantic-field required

Generic properties of this value type.

documentation: DocumentationMetadataModel pydantic-field required

Documentation for the value type.

origin: OriginMetadataModel pydantic-field required

Information about the creator of this value type.

python_class: PythonClassMetadata pydantic-field required

The Python class for this value type.

type_name: str pydantic-field required

The registered name for this value type.

OriginMetadataModel pydantic-model

authors: List[kiara.metadata.core_models.AuthorModel] pydantic-field

The authors/creators of this item.

PythonClassMetadata pydantic-model

Python class and module information.

class_name: str pydantic-field required

The name of the Python class.

full_name: str pydantic-field required

The full class namespace.

module_name: str pydantic-field required

The name of the Python module this class lives in.