Setup Plugin for Development

Plugins need to be installed as python packages for the Peek Platform to run them. This is typically done with a command similar to pip install peek-plugin-noop.

Python packages can be installed in “development” mode, where your code being developed is only linked into the python environment.


For developing an existing plugin ensure there are no installed releases pip uninstall peek-plugin-example. Confirm installed peek packages with pip freeze | grep peek.

This is achived with the following command in the plugin project root directory, where is:

# Check to ensure we're using the right python
which python

python develop

Configure Peek Services

The python peek services, worker, agent, field, office, and logic need to have the plugin enabled in their ~/peek-service/config.json.

For example:

"plugin": {
    "enabled": [

Run the Plugin

Now that the plugin has been setup for development and the platform has been configured to run it, running the platform will run the plugin.

See the Setup IDE procedures to run the platform and debug plugins under those.

If a platform service, (run_peek_logic_service for example) is run under the IDEs debugger, it will also debug the plugins the platform loads.

Run the platform services from bash with the following commands:

# Check to ensure we're using the right python
which python

# Run the peek logic service

# Run the peek office service

# Run the peek field service

# Run the peek agent

# Run the peek worker