ESP Python Client documentation

Overview:

ESP Client, or the esp python module, is a programmatic entry point for interacting with ESP. With this module, you can (among many things):

  • Set up connections to ESP and query API routes.

  • Create new Workflows and associated Protocols.

  • Create Experiments and fill out Worksheets with real data.

  • Programmatically pull data from the ESP database for external processing.

Having a programmatic wrapper for interacting with ESP is paramount to leveraging the data ESP is able to capture. This wrapper abstracts away a lot of the complexities associated with querying a REST API, and is designed to provide an intuitive entry-point to accessing data from each of the models within the application.

For basic installation instructions, see the Installation section to get started.

For information on basic use, and the high-level patterns consistent across the API, see the Usage section.

For examples of how to use the python client for interacting with the ESP database, see the Examples section.

For detailed API documentation on each of the models within the python client, see the Client API section.

For REST documentation detailing the entry points used by the python client, see the REST API section.

Finally, for information about the command-line entry point for using the moduel, see the Command Line section.

Contents:

Indices and tables