Skip to content

hyfi.about

About

Bases: BaseModel

A Pydantic BaseModel that contains metadata about the package.

Attributes:

Name Type Description
name str

The display name of the package.
authors str

The author(s) of the package.
description str

A brief description of the package.
homepage str

The URL of the package's homepage.
license str

The license under which the package is distributed.
Source code in hyfi/about/about.py 
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
class About(BaseModel):
    """A Pydantic BaseModel that contains metadata about the package.

    Attributes:
        name (str): The display name of the package.
        authors (str): The author(s) of the package.
        description (str): A brief description of the package.
        homepage (str): The URL of the package's homepage.
        license (str): The license under which the package is distributed.
    """

    _config_group_: str = "/about"
    _auto_populate_: bool = True

    name: str = __hyfi_name__
    authors: str = __hyfi_authors__
    description: str = __hyfi_description__
    homepage: str = __hyfi_homepage__
    license: str = __hyfi_license__