Metadata-Version: 2.1
Name: psi-pshell
Version: 2.1.0
Summary: Python client to PShell REST API
Home-page: https://github.com/paulscherrerinstitute/pshell/tree/master/python
Author: Paul Scherrer Institute
Author-email: daq@psi.ch
License: GPLv3
Description-Content-Type: text/markdown
Requires-Dist: requests
Requires-Dist: sseclient
Requires-Dist: pyzmq

# Overview

This package implements a Python client to PShell REST API.

- Project URL: https://github.com/paulscherrerinstitute/pshell

# Installation

Install via pip:

```
pip install psi-pshell
```

Dependencies:
  - requests
  - sseclient
  - pyzmq

# Classes
  - PShellClient: client to PShell sequencer API, providing access to the interpreter, event receiving, control of the state machine, data retrieval and plot visualization.
  - PShellProxy: PShellClient extension adding functions to run scans and control devices as in PShell console.
  - PlotClient: client to PShell plotting API, allowing externalize plots to PShell's Plotter application.
