fiftyone-plugins

This repo serves as a registry for all external fiftyone plugins developed by Voxel51. If you are looking for Fiftyone core (built-in) plugins you can find them here.

Running plugins

To run the plugins you first need to build them (make sure you a dist/index.umd.js file in the plugin directory)

After that set the FIFTYONE_PLUGIN_DIR environment variable to be the path to the packages directory. Fiftyone will pick them up after that.

Contributing

There are a few ways to use this repository.

1. Clone and run the plugins. Eg. the debugger plugin is useful for troubleshooting Fiftyone issues.
2. As a starter sekelton for building your own plugin.
3. As a contributor to a Voxel51 external plugin. Note: contributions can be made to core plugins here.

Prerequisites

• You must have fiftyone setup for sdk and app development. Follow these instructions to get setup.
• Set the FIFTYONE_DIR env var to the location where you cloned the fiftyone repo.

Install

1. clone the repository and cd fiftyone-plugins
2. run bash install.bash to install the dev dependencies.

Develop

1. run yarn workspace $PLUGIN_NAME dev to compile/watch the given plugin
2. follow these instructions to run Fiftyone from source.
3. [Kirill's recommendation] Symlink the folder with the plugin into $FIFTYONE_DIR/app/packages for autocompletion to work (then work with the plugin in the symlinked directory, while building from the original folder)

Create your own Plugin

1. After running all the steps above, you should be ready to create your own plugin.
2. You can re-use this directory / repo, or re-clone a new copy.
3. Run yarn create-plugin <Your-Plugin-Name> to create a new plugin. Then to install dependencies re-run bash install.bash.