Pysmith

class pysmith.Pysmith(*, src, dest)[source]

The main pipeline processing object. To minimize potential issues, it is recommended that all paths are passed as absolute paths.

Parameters

  • src (str) – The path to the source directory.

  • dest (str) – The path to the destination directory.

enable_logging()[source]

Enables basic logging while the build is running.

Returns

self

use(plugin)[source]

Add a new plugin instance to the pipeline.

Parameters

plugin – A plugin that implements the build() method.

Returns

self

clean()[source]

Recursively deletes the destination directory.

Returns

self

build()[source]

Executes the plugins in the pipeline to run the build.