Skip to main content

Toolbox for accessing ASAM ODS servers using the HTTP API

Project description

ASAM ODSBox

The ODSBox is a lightweight Python wrapper on the standardized ASAM ODS REST API. Using intuitive JAQuel queries and pandas.DataFrames the ODSBox makes dealing with ASAM ODS data in Python more fun.

from odsbox.con_i import ConI

with ConI(url="https://MY_SERVER/api", auth=("sa", "sa")) as con_i:
    measurements = con_i.query_data(
        {
            "AoMeasurement": {"name": {"$like": "*"}},
            "$attributes": {"name": 1, "id": 1},
            "$options": {"$rowlimit": 50},
        }
    )
    print(measurements)

Documentation

Communication

The ASAM ODS server is called using HTTP calls defined by the ASAM ODS standard. The messages are encode/decoded using ASAM ODS protobuf message definitions provided at ASAM-ODS-Interfaces. As content type application/x-asamods+protobuf is used.

JAQuel Queries

JAQuel allows you to query your data in a simple and intuitive way inspired by MongoDB Query Language (MQL). The definition of query expression as JSON easily integrates with the Python language – a win-win situation.

Installation

ODSBox is available on.

github https://github.com/peak-solution/odsbox/
PyPI https://pypi.org/project/odsbox/
github docs https://peak-solution.github.io/odsbox
# access ASAM ODS server
pip install odsbox
# access ASAM ODS EXD-API plugin
pip install odsbox[exd-data]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

odsbox-1.0.0rc137.post1.tar.gz (89.6 kB view hashes)

Uploaded Source

Built Distribution

odsbox-1.0.0rc137.post1-py3-none-any.whl (46.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page