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.5.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.5-py3-none-any.whl (49.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: odsbox-1.0.5.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.5.tar.gz
Algorithm Hash digest
SHA256 2580749334fa314dd94d943fd942d0a3390f2d5856db37d5364a9d1917798054
MD5 0ec4e9635fb2511b9278b81dcf178f3a
BLAKE2b-256 7b7be09b5ba9c52ca79e7e94ed57e750ef8c3432e1a619c5ba8ee4e281807b55

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for odsbox-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 3e88609afcaf479d4eeca185d2a1e7cfb0e69920e2bbfe76b1d9629b48d10a0f
MD5 9439e58b7d47a0e9bc8452246a84d271
BLAKE2b-256 7e807166cf1c69f18ccf4e30b5e8c1b1a3ed1f9c51ece167e3b472d8c30944df

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