Metadata-Version: 2.1
Name: modality
Version: 0.0.1
Summary: A python client library for the Modality API
Project-URL: Homepage, https://github.com/auxoncorp/modality-sdk/client-libraries/python
Project-URL: Bug Tracker, https://github.com/auxoncorp/modality-sdk/issues
Author-email: Russell Mull <russell@auxon.io>
License-File: LICENSE
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.7
Description-Content-Type: text/markdown

# Python Client Library for Modality

This is a library for the python programming language used to interact with
Auxon's Modality suite of products.

It currently provides read access to data stored within the Modality database,
both as raw trace data and in-place statistical analyses.

The primary interface is in `modality.client`. The functions
`events_dataframe`, `event_value_distributions_dataframe`,
`experiment_overview`, and `workspace_segments` allow access to trace data
stored within modality. See the inline documentation for more information, eg.:

```python
from modality import client
help(client)
```

## Running tests

```python
pip3 install -U pytest
pip3 install -U appdirs
pytest
```
