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.5rc260.post1.tar.gz (97.4 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.5rc260.post1-py3-none-any.whl (49.9 kB view details)

Uploaded Python 3

File details

Details for the file odsbox-1.0.5rc260.post1.tar.gz.

File metadata

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

File hashes

Hashes for odsbox-1.0.5rc260.post1.tar.gz
Algorithm Hash digest
SHA256 a246395a004bf0254367e2d1a87519d43ac3a5dcff8ab2d3907eddaadf94a742
MD5 7d5bf76f6c44c8627566f860838ff5c0
BLAKE2b-256 9f5fb8652a7c4514b5272e8505b7bfe018586d63e9fcccf50c027d1dfb711326

See more details on using hashes here.

File details

Details for the file odsbox-1.0.5rc260.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for odsbox-1.0.5rc260.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 60e3e0dee15a9b5813bfc09f74fb6607334181a1c0a62a75bb27931c2b3babcc
MD5 1b4be19a3ec6febaae58ab92677545d7
BLAKE2b-256 c56c346fc34822bb1b8f37cb7425f795d6be0e2dd3f0a26deefb684c495c0e06

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