Skip to content

Latest commit

 

History

History
71 lines (52 loc) · 2.4 KB

README.md

File metadata and controls

71 lines (52 loc) · 2.4 KB

TODO component catalog connector

This catalog connector enables Elyra to load pipelines components from TODO.

Install the connector

You can install the TODO catalog connector from PyPI or source code. Note that a rebuild of JupyterLab is not required.

Prerequisites

  • Elyra (version 3.3 and above).
  • TODO

Install from PyPI

$ pip install todo-component-catalog-connector

Install from source code

$ git clone https://github.com/elyra-ai/examples.git
$ cd examples/component-catalog-connectors/connector-template/
$ make source-install

Use the connector

  1. Launch JupyterLab.
  2. Open the 'Manage Components' panel.
  3. Add a new TODO component catalog ('+' > 'New TODO Component Catalog').
  4. Specify a catalog name, e.g. 'Test TODO catalog'.
  5. (Optional) Specify a category under which the catalog's components will be organized in the palette.
  6. Configure the required todo_required_parm.
  7. Configure the optional todo_optional_parm.
  8. Save the catalog entry.
  9. Open the Visual Pipeline Editor and expand the palette. The catalog components are displayed.

Uninstall the connector

  1. Remove all TODO catalog entries from the 'Manage Components' panel.
  2. Stop JupyterLab.
  3. Uninstall the todo-component-catalog-connector package. 
    $ pip uninstall -y todo-component-catalog-connector

Troubleshooting

Problem: The palette does not display any components from the configured catalog.

Solution: If the the Elyra GUI does not display any error message indicating that a problem was encountered, inspect the JupyterLab log file.