📜 List of Meerschaum Plugins

This page contains a list of plugins available on the public Meerschaum repository. To install a plugin, run the command mrsm install plugin <name>.

In case you would like to showcase your plugin or ask questions, please share in the GitHub discussion thread!

If you have written a Meerschaum plugin and would like it published to the public repository, run the following commands (replacing values in angle brackets):

### Register an account at instance `api:mrsm`.
mrsm register user <myusername> -i api:mrsm

### Login with your new account.
mrsm login api:mrsm

### Register your plugin to repository `api:mrsm`.
mrsm register plugin <myplugin> -r api:mrsm

Data Plugins

Data plugins are used to incorporate third party data sources into Meerschaum. To use a data plugin, bootstrap a new pipe and choose the plugin as its connector.

apex

The apex plugin connects to Apex Clearing's API so you may extract your transaction history. For example, this plugin may be used to extract transactions from M1 Finance.

GitHub | Source

covid

The covid plugin fetches county-level COVID-19 data from various state health departments as well as the New York Times. It depends on other plugins: US-covid, TX-covid, GA-covid, CA-covid, and CO-covid.

GitHub | Source

noaa

The noaa plugin reads weather station data from the NOAA Weather API.

GitHub | Source

sense

The sense plugin fetches environment readings from the Raspberry Pi Sense HAT.

GitHub | Source

stress

The stress plugin generates random data with parameters for number of IDs and rows to help you with stress testing (~99% inserts, ~1% updates).

Source

Action Plugins

Action plugins add new commands to the Meerschaum system.

color

The color plugin provides a shortcut to inverting the ANSI and Unicode configuration settings.

Source

compose

Meerschaum Compose lets you define your project in one YAML file, like docker-compose but for Meerschaum.

GitHub | Source

syncx

The plugin syncx contains implementations of the experimental syncing methods I describe in my master's thesis (abstract).

GitHub | Source

thanks

The thanks plugin generates the acknowledgments page from PyPI metadata for optional Meerschaum dependencies.

Source

API Plugins

API plugins extend the web API's fastapi app.

sso

The sso plugin is written to demonstrate how to integrate a Google sign-in and add additional endpoints. This plugin is also used as part of the back-end for this wedding website.

GitHub | Source