Online Filters #

Regolith allows custom filters to be placed on GitHub. This is perfect for a filter that you want to make public, or potentially share internally in a team.

The standard filters library is a good reference for how to structure an online filter, but we will also explain here.

Creating Online Filter #

To create an online filter, your github project needs to be structured in a certain way. For starters, every filter needs its own folder, at the top of the github project. This folder name is very important, as it will be the name of the filter.

You should move your programs and scripts into this folder. When your filter is installed, everything in this folder will be downloaded.

filter.json #

filter.json is a special file, which you should place at the top level of your filters folder. Once again, check out the standard-library for examples of a property structured regolith filter.

{
  "description": "A Hello World Filter - this will be displayed as a description on website pages.",
  "filters": [
    {
      "runWith": "python",
      "script": "./hello_world.py"
    }
  ]
}

Data Folder #

If you need some default configuration files for your remote filter, you can create a folder called data in your filter folder. Here, you can store your default configuration files. When a user runs regolith install, this data folder will be moved into their data folder, namespaced under the name of the filter.

You can learn more about this flow here.

Test Folder #

It may be useful to you to include a test project, or test files, which are useful for development, but don't need to be downloaded by the end user. Anything placed in the test folder will not be installed by Regolith, and you can use this space for your own development.