Labstep is a flexible research environment that connects your electronic notebook, inventory, applications, and data in one collaborative workspace.

labstepPy is a Python package for working with the Labstep API. This guide is for anyone who wants to automatically attach analysis scripts and data to your experiments on Labstep.

All the labstepPy code is available under open source licenses from repositories at github.


The labstep package can be easily installed using pip.

Open the Terminal, and do:

pip install labstep

Quick Example

The quick example below shows you how to attach a Labstep Protocol to a Labstep Experiment.

To see what else labstepPy can do, see more example uses.

import labstep

# Login to your Labstep account
user = labstep.login('', 'mypassword')

# Get a list of your experiments
experiments = user.getExperiments(count=10)

# Get a specific experiment
my_experiment = user.getExperiment(23973)

# Get a specific protocol
my_protocol = user.getProtocol(4926)

# Attach the protocol to the experiment
result = my_experiment.addProtocol(my_protocol)


Always ensure you are using the latest version of the SDK by running:

pip install labstep --upgrade

If you have further issues please contact for support.


  • Sze May Yee
  • Barney Walker

Getting Involved

labstepPy is an Open Source package.

Feel free to submit bug reports, feature requests or PRs on Github here.

If you are interested in contributing please contact

Indices and tables