Skip to main content

Turning your plugins into a Python package to share

If you'd like to contribute your plugin to the community, this is done easily by creating a Python package and uploading to PyPi. Let's walk through this!

Organizing your files

tip

Note that the way files are organized may depend on if your plugin is an automation or a job. Plugins can install both automations and jobs.

Consider an example plugin: a job called Relay, which just turns on or off anything thats plugged into a channel of your choosing. Follow the file organization here: kellytr/pioreactor-relay-plugin.

Here's a general schematic of how your files should be organized for a job:

📁 my-plugin-name
├─ 📁 my_plugin_name
│ ├─ 📁 ui
│ │ ├─ 📁 contrib
│ │ │ ├─ 📁 jobs
│ │ │ │ ├─ 📝 my_plugin.yaml
│ ├─ 📝 __init__.py
│ ├─ 📝 additional_config.ini
│ ├─ 📝 my_plugin.py
├─ 📝 LICENSE.txt
├─ 📝 MANIFEST.in
├─ 📝 README.md
├─ 📝 setup.py

The schematic is very similar for an automation plugin the only difference is the location of the .yaml file.

📁 my-plugin-name
├─ 📁 my_plugin_name
│ ├─ 📁 ui
│ │ ├─ 📁 contrib
│ │ │ ├─ 📁 automations
│ │ │ │ ├─ 📁 <SPECIFIC AUTOMATION (ex. either dosing, led, or temperature)>
│ │ │ │ │ ├─ 📝 my_plugin.yaml
│ ├─ 📝 __init__.py
│ ├─ 📝 additional_config.ini
│ ├─ 📝 my_plugin.py
├─ 📝 LICENSE.txt
├─ 📝 README.md
├─ 📝 MANIFEST.in
├─ 📝 setup.py

Start by creating a new folder for your plugin. In our case, we named it pioreactor-relay-plugin. This main folder will contain 4 important parts:

1. A license text file, named LICENSE.txt

A common license for software is the MIT license.

2. A MANIFEST file, named MANIFEST.in

When creating a Python package, there's a default set of files that are included. To assure that our additional configuration and yaml files are included, create a MANIFEST.in file and paste the following:

include <MAIN FOLDER>/additional_config.ini
recursive-include <MAIN FOLDER>/ui/ *.yaml

3. A README.md

Write a few notes with general information on your plugin to guide users.

4. A Python setup.py file

Create a Python file and paste the following. Make changes based on your own plugin information.

# -*- coding: utf-8 -*-
from setuptools import setup, find_packages

setup(
name="pioreactor_relay_plugin",
version="<VERSION>",
license_files = ('LICENSE.txt',),
description="<DESCRIPTION OF PLUGIN>",
long_description=open("README.md").read(),
long_description_content_type="text/markdown",
author_email="<EMAIL>",
author="<NAME>",
url="<YOUR HOMEPAGE>",
packages=find_packages(),
include_package_data=True,
entry_points={
"pioreactor.plugins": "<SUBFOLDER CONTAINING PLUGIN> = <SUBFOLDER CONTAINING PLUGIN>"
},
)

5. A subfolder containing your plugin's code

Within the main file pioreactor-relay-plugin, we created a subfile pioreactor_relay_plugin.

Contents of the subfolder:

1. Your plugins Python files

This Python file contains the core code for your plugin. If your plugin is implementing a background job, then there should be a function decorated with @click.command at the bottom of the file. See example here. For discovery reasons, this function's name should start with click_ .

2. A Python __init__.py file

If implementing an automation:

Import the Class of your automation file:

from <SUBFOLDER CONTAINING PLUGIN>.<PYTHON FILE NAME> import <CLASS NAME>
If implementing a job:

This will contain an import statement such as the following:

from <SUBFOLDER CONTAINING PLUGIN>.<PYTHON FILE NAME> import <PLUGIN CLICK FUNCTION>

This imports the function within our plugin file that executes our plugin action.

Example for the relay plugin:

from pioreactor_relay_plugin.relay import click_relay

where click_relay is the function decorated with @click.command.

3. A configuration file, named additional_config.ini

This configuration file will contain additional configs that we want to add to our list of existing Configurations on the Pioreactor web interface. This file will be merged with the existing config.ini when the plugin is installed.

tip

A convention we've tried to follow is to use the section name [<job_name>.config] or [<automation_name>.config] in the configuration files. For example, our relay job has [relay.config] in its additional_config.ini and settings under it.

4. Adding details to the UI

If implementing a job:

Within our main subfolder, create subfolders named ui/contrib/jobs. Move your .yaml file to this folder.

For a job, the .yaml file should follow this format:

---
display_name: # human readable name
job_name: # job name
display: # bool; true to display on the /Pioreactors card
source: # name of your plugin
description: # description of what your plugin does
published_settings:
- key: # as defined in Python
unit: # unit (ml, lux, AU, etc.)
label: # human readable name
description: # description of your setting
type: # one of numeric, boolean, text
default: # provide a default value
display: # bool; true to display on the /Pioreactors card
...
If implementing an automation:

In the case of creating an automation plugin instead of a job, the subfolders are ui/contrib/automations/<SPECIFIC AUTOMATION>, where SPECIFIC_AUTOMATION is one of dosing, led, or temperature. Move your .yaml file to the final subfolder.

The.yaml file of an automation should appear as the following:

---
display_name: # human readable name
automation_name: # automation name
source: # folder that contains your plugin
description: # description of your plugin
fields:
- key: # as defined in Python
unit: # unit of your key
label: # human readable name
description: # description of your key

Create a Python package on PyPi

Create an account on https://pypi.org/. Make sure to verify your email.

On your command line, type the following:

pip install twine
pip install --upgrade build
python -m build --wheel
twine upload dist/<.WHL FILE>

You will then be prompted for a username and password. Use the credentials for your PyPi account. Then, your package is uploaded and viewable at the link provided!

Note

Before you build a new wheel, it's good practice to clean up your previous build.
This can be done using python setup.py clean --all on the command line.

Installing your Python package on your cluster

A plugin can be installed individually through the command line on a leader using pio:

pios install-plugin <PACKAGE NAME>

To install a given plugin on the leader and all workers connected to the leader in a cluster, pios install-plugin can be used.

pios install-plugin <PACKAGE NAME>

Sharing your plugin with the community

To give your plugin futher reach, we've provided an option to add it to the web interface. You will need to edit the plugins.json file within our Pioreactor repository, list-of-plugins.

There are two ways to do this:

  1. Create an issue to have us edit the plugins.json file for you.
  2. Fork from our repository to edit the plugins.json file, then create a pull request.

In both cases, we will evaluate your plugin to ensure code quality and all requirements are met (tests are included).

Once your plugin is accepted, it will appear on the Plugins tab on the Pioreactor web interface. Users in the community can now easily click Install to download your plugin onto their Pioreactors!