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.6rc285.post1.tar.gz (97.6 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.6rc285.post1-py3-none-any.whl (50.0 kB view details)

Uploaded Python 3

File details

Details for the file odsbox-1.0.6rc285.post1.tar.gz.

File metadata

  • Download URL: odsbox-1.0.6rc285.post1.tar.gz
  • Upload date:
  • Size: 97.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.32.4

File hashes

Hashes for odsbox-1.0.6rc285.post1.tar.gz
Algorithm Hash digest
SHA256 a6bbabc7e9f24f8926fcde1b0b05397df4ee7fa5c2586924f22bed18cde87a95
MD5 2a9414ddd70a9b0bbcb41f66598cc788
BLAKE2b-256 aaae4fc80fb241bc16c8669308ca9fefe22f8152f0c1384d45aaa0c7907bd046

See more details on using hashes here.

File details

Details for the file odsbox-1.0.6rc285.post1-py3-none-any.whl.

File metadata

File hashes

Hashes for odsbox-1.0.6rc285.post1-py3-none-any.whl
Algorithm Hash digest
SHA256 bfb4b5e7e3a937ec9baf39b674a47d4acf8d550eb75660853026ed6f7807f58f
MD5 af50b0368eb2aae6814d2027a0dd36d7
BLAKE2b-256 cd01bc4bb9cf5d05a8cb6db056074fb758f44a1ccb14b56ffbc7e4fda862602a

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