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

This version

1.0.1

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.1.tar.gz (90.5 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.1-py3-none-any.whl (47.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for odsbox-1.0.1.tar.gz
Algorithm Hash digest
SHA256 f9d87f64ee527c8aaa6332751162a7e8b0dc2d264f769bf0111cc3a63b259e78
MD5 3e20749dac170bb84192d451d2f6afa1
BLAKE2b-256 62560b7370e371a542f86d707c7c0cbed8e5b684661985c231a7f38e23610192

See more details on using hashes here.

File details

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

File metadata

  • Download URL: odsbox-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 47.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.3

File hashes

Hashes for odsbox-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8f12b0744468b153618904d69d69246321d76fae63ce521f4ccd4b50fcb9413e
MD5 a87f32d121ef7619402dee10687ecebf
BLAKE2b-256 6d2f7b1c75497f6727ff9f7b701325e0b1dbadad62cd7c220ae4c9f0c74e4fed

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