PythonPackageModel

class documenteer.conf._toml.PythonPackageModel(**data)

Bases: BaseModel

Model for a Python package (i.e. built with pyproject.toml-compatible build system.

Parameters:

data (Any)

Attributes Summary

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Methods Summary

validate_package(v)

Ensure the package is importable.

Attributes Documentation

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

Methods Documentation

classmethod validate_package(v)

Ensure the package is importable.

Parameters:

v (str)

Return type:

str