queenbee.base.metadata module¶

Queenbee MetaData class.

This object provides metadata information for a package.

The specification is designed based on openapi info object: https://swagger.io/specification/#infoObject

class queenbee.base.metadata.License(*, type: ~typing.Literal['License'] = 'License', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, url: ~pydantic.networks.AnyUrl | None = None)[source]¶

Bases: BaseModel

License information for the Package

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

name: str¶

type: Literal['License']¶

url: AnyUrl | None¶

class queenbee.base.metadata.Maintainer(*, type: ~typing.Literal['Maintainer'] = 'Maintainer', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, email: str | None = None)[source]¶

Bases: BaseModel

Maintainer information

email: str | None¶

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

name: str¶

type: Literal['Maintainer']¶

class queenbee.base.metadata.MetaData(*, type: ~typing.Literal['MetaData'] = 'MetaData', annotations: ~typing.Dict[str, ~typing.Any] = <factory>, name: str, tag: str, app_version: str | None = None, keywords: ~typing.List[str] | None = None, maintainers: ~typing.List[~queenbee.base.metadata.Maintainer] | None = None, home: str | None = None, sources: ~typing.List[str] | None = None, icon: str | None = None, deprecated: bool | None = None, description: str | None = None, license: ~queenbee.base.metadata.License | None = None)[source]¶

Bases: BaseModel

Package metadata information.

app_version: str | None¶

deprecated: bool | None¶

description: str | None¶

home: str | None¶

icon: str | None¶

keywords: List[str] | None¶

license: License | None¶

maintainers: List[Maintainer] | None¶

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

name: str¶

sources: List[str] | None¶

tag: str¶

type: Literal['MetaData']¶