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


Release history Release notifications | RSS feed

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.1rc170.post1.tar.gz (92.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

odsbox-1.0.1rc170.post1-py3-none-any.whl (47.8 kB view details)

Uploaded Python 3

File details

Details for the file odsbox-1.0.1rc170.post1.tar.gz.

File metadata

  • Download URL: odsbox-1.0.1rc170.post1.tar.gz
  • Upload date:
  • Size: 92.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for odsbox-1.0.1rc170.post1.tar.gz
Algorithm Hash digest
SHA256 ff698c6d779447e39113d9fe2260d12535e4e329fa2d2d71c7c78fc6c6d62c44
MD5 38dd12b8a5928c0ab58ac4af44e8d2b1
BLAKE2b-256 9723914e7fdae7b82363f79a7954d08fca67e54b57cc0a58e788824da6d26890

See more details on using hashes here.

File details

Details for the file odsbox-1.0.1rc170.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for odsbox-1.0.1rc170.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 9f6ebd182d2a24188c961bb5d30e741c798fa6f9f34f23611512d8ed8f80082b
MD5 900a49f8b92ec3df92897220e6114fe9
BLAKE2b-256 892d171a335e556212c923429d5a2a136dfd18372d683e7c179613c67bc76cd3

See more details on using hashes here.

Supported by

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