PythonPackageModel

pydantic model documenteer.conf._toml.PythonPackageModel

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

Parameters:

data (Any)

Show JSON schema

{
   "title": "PythonPackageModel",
   "description": "Model for a Python package (i.e. built with pyproject.toml-compatible\nbuild system.",
   "type": "object",
   "properties": {
      "package": {
         "description": "Package name",
         "title": "Package",
         "type": "string"
      },
      "documentation_url_key": {
         "default": "Homepage",
         "description": "Key for the documentation URL in the pyproject.toml [project.urls] table. The corresponding URL is used for the Sphinx html_baseurl configuration, which in turns sets the canonical URL link relation on the web pages.",
         "title": "Documentation Url Key",
         "type": "string"
      },
      "github_url_key": {
         "default": "Source",
         "description": "Key for the documentation URL in the pyproject.toml [project.urls] table. The corresponding URL is used for as an alternative to setting [project.github_url].",
         "title": "Github Url Key",
         "type": "string"
      }
   },
   "required": [
      "package"
   ]
}

Fields:

• documentation_url_key (str)

• github_url_key (str)

• package (str)

Validators:

• validate_package » package

field documentation_url_key: str = 'Homepage'

Key for the documentation URL in the pyproject.toml [project.urls] table. The corresponding URL is used for the Sphinx html_baseurl configuration, which in turns sets the canonical URL link relation on the web pages.

field github_url_key: str = 'Source'

Key for the documentation URL in the pyproject.toml [project.urls] table. The corresponding URL is used for as an alternative to setting [project.github_url].

field package: str [Required]

Package name

Validated by:

• validate_package

validator validate_package  »  package

Ensure the package is importable.

Parameters:

v (str)

Return type:

str