Custom metadata hook¶

This is a custom class in a given Python file that inherits from the MetadataHookInterface.

Configuration¶

The metadata hook plugin name is custom.

pyproject.toml hatch.toml

[tool.hatch.metadata.hooks.custom]

[metadata.hooks.custom]

Option	Default	Description
`path`	`hatch_build.py`	The path of the Python file

hatch_build.py

from hatchling.metadata.plugin.interface import MetadataHookInterface


class CustomMetadataHook(MetadataHookInterface):
    ...

If multiple subclasses are found, you must define a function named get_metadata_hook that returns the desired build hook.

Note

Any defined PLUGIN_NAME is ignored and will always be custom.

Last update: July 2, 2022