----------------------------------------------------------------------
This is the API documentation for the gdtest_autolink library.
----------------------------------------------------------------------


## Classes

Main classes provided by the package


Config(name: str = 'default') -> None

Configuration for pipelines.

Parameters
----------
name
    The config name.

Engine(name: str) -> None

Core processing engine.

Use ``Pipeline`` to chain multiple engines together.
Call ``run_pipeline()`` to execute a full pipeline.

The ``~~gdtest_autolink.Config`` class holds settings.

Parameters
----------
name
    The engine name.

Pipeline(steps: list = None) -> None

A chain of processing steps.

Each step uses an ``Engine`` instance. Configure with
``Config``.

See ``~~.gdtest_autolink.run_pipeline`` for a shortcut
to running the full pipeline.

Parameters
----------
steps
    List of engine names.


## Functions

Utility functions


run_pipeline(data: dict, config: gdtest_autolink.Config = None) -> dict

Execute a full pipeline on the given data.

Creates a ``Pipeline`` from the ``Config`` and runs each
``Engine`` step in order.

Parameters
----------
data
    Input data to process.
config
    Pipeline configuration. See ``Config`` for options.

Returns
-------
dict
    Processed output data.