Weaverbird publishes two packages:

NPM package

The npm package contains two concerns:

  • a graphical user interface,
  • some translators.

Its main language is TypeScript.

GUI

The graphical user interface generates a list of transformation steps that can be translated afterwards on supported backends.

See UI components for more details on usable components.

Translators

Translators serves two purposes today:

  • declaring a set of supported steps so only display these steps
  • optionally provide a way to translate a pipeline into a query understandable by a backend

See how to write a new translator for a deep-dive.

Python package

The python module provide a way to run transformations described in a pipeline. Its code reside in the server/ folder.

More info in its dedicated usage docs.