Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
110 lines (75 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

110 lines (75 loc) · 3.17 KB
Raw

Contributing to fiftyone-plugins

Thanks for your interest in contributing to fiftyone-plugins!

Pre-commit hooks

If you plan to contribute a PR, please check install the pre-commit hooks before committing:

pre-commit install

You can manually lint a file if necessary like so:

# Manually run linting configured in the pre-commit hook
pre-commit run --files <file>

Local development

When developing locally, you must make your source install of this repository available to FiftyOne.

A convenient way to do that is to symlink this repository into your FiftyOne plugins directory:

cd /path/to/fiftyone-plugins
ln -s "$(pwd)" "$(fiftyone config plugins_dir)/voxelgpt"

Prerequisites

  • Follow these instructions to install Fiftyone from source
  • Checkout contribution guide for Fiftyone project
  • Set the FIFTYONE_DIR environment variable to the location where you cloned the fiftyone repository

Install dependencies to create and build a plugin

  • Run yarn install

Create a new plugin

  • Run yarn create-plugin <your-plugin-name> to create a new plugin

Source install

  • Run bash install.bash to install the dev dependencies

Build JavaScript assets (Panel, Operators, etc.) for a plugin [Optional]

  • Run yarn workspace <plugin-name> dev to compile/watch a plugin

Build JavaScript assets outside of fiftyone-plugins repository [Optional]

To get started with building a new JavaScript plugin outside of fiftyone-plugins repository, use the hello-world-plugin-js repository as a base. It provides a minimal, working template that includes a sample JavaScript operator and a sample JavaScript panel. Clone the repository, rename it appropriately, and customize the operator and panel to fit your use case.

Tests

This project contains multiple plugins, each with its own set of tests. To simplify the testing process, we've included a script called run_all_tests.sh that automatically finds and runs tests in all plugin directories.

About the run_tests.sh Script

The run_tests.sh script:

  • Iterates through all subdirectories under the ./plugins directory.
  • Checks each plugin for a non-empty tests directory.
  • Runs pytest in each tests directory found.
  • Reports test results and indicates whether all tests passed or if any failures occurred.
  • Adds the ./plugins directory to the PYTHONPATH.

How to run the tests

To run tests for all plugins, simply execute the script using the following command:

# ensure pytest is installed
pip install pytest

# run all the tests
bash run_tests.sh

# or run an individual plugins tests
bash run_tests.sh hello_world

Using pytest directly

You can also use pytest directly by emulating the setup in run_tests.sh.

  • Ensure you have $FIFTYONE_PLUGINS_DIR/plugins in your PYTHONPATH
  • Run a test file and use pytest as expected
  • eg pytest ./plugins/hello_world/test_count_samples.py -v