Extension hookspec#

sdgx.data_models.inspectors.extension.hookimpl = <pluggy._hooks.HookimplMarker object>#

Hookimpl marker for this extension, extension module should use this marker

Example

@hookimpl
def register(manager):
    ...
sdgx.data_models.inspectors.extension.project_name = 'sdgx.metadata.inspector'#

The entry-point name of this extension.

Should be used in pyproject.toml as [project.entry-points."{project_name}"]

sdgx.data_models.inspectors.extension.register(manager)[source]#

For more information about this function, please check the Manager

We provided an example package for you in {project_root}/example/extension/dummymetadatainspector.

Example:

class MyOwnInspector(Inspector):
    ...

from sdgx.data_models.inspectors.extension import hookimpl

@hookimpl
def register(manager):
    manager.register("DummyInspector", MyOwnInspector)

Config project.entry-points so that we can find it

[project.entry-points."sdgx.metadata.inspector"]
{whatever-name} = "{package}.{path}.{to}.{file-with-hookimpl-function}"