.. Pipeline Import documentation

Generic steps
=============

.. module:: xmm.pipeline.steps

PipelineStep
~~~~~~~~~~~~

.. autoclass:: PipelineStep


DebugStep
~~~~~~~~~

.. autoclass:: DebugStep

NotifyStep
~~~~~~~~~~

.. autoclass:: NotifyStep
   :members: __init__

Sends a notification about the successful import or export.

**Arguments:**

This step takes no arguments.

**Added context:**

- bool `notify`: Will set `notify` to True.

ProgressStep
~~~~~~~~~~~~

.. autoclass:: ProgressStep
   :members: __init__

Shows a progressbar when stderr is a terminal, or the progress in percent when stderr is a file.

**Arguments:**

- int `step`: Step size in percent (defaults to 5).

**Added context:**

This step adds no context.

FlattenStep
~~~~~~~~~~~

.. autoclass:: FlattenStep

ExpandStep
~~~~~~~~~~

.. autoclass:: ExpandStep

RebuildIndexStep
~~~~~~~~~~~~~~~~

.. autoclass:: RebuildIndexStep

SplitStep
~~~~~~~~~

.. autoclass:: SplitStep

SwitchStep
~~~~~~~~~~

.. autoclass:: SwitchStep