odsbox-pilot

ODS Pilot is a desktop application for querying and exploring ASAM ODS measurement-data servers. It provides an interactive GUI that lets you write and run queries, browse the data hierarchy, and inspect the entity-relation model — all without writing any code.

Features at a glance

Requirements

• Python 3.14 or later
• A running ASAM ODS server (REST API)

Installation

Quickest start — no install needed (always runs the latest release):

uvx odsbox-pilot[gui]@latest

Install as a persistent tool with uv:

uv tool install odsbox-pilot[gui]
odsbox-pilot

Install with pip:

pip install odsbox-pilot[gui]
python -m odsbox_pilot

Quick start

1. Launch ODS Pilot — the Server List dialog opens automatically.
2. Click New… and enter your server URL, username, and password.
3. Double-click your server (or select it and click Connect).
4. Use the tabs to query, browse, and inspect your data.

Right-click a saved server in the list to import or export portable .ods-pilot.con.json files. Exported files omit secrets and only keep the non-default fields needed to recreate the connection.

Command-line shortcuts:

odsbox-pilot --server "My Server"   # connect by saved name
odsbox-pilot --list-servers         # print all saved names
odsbox-pilot --import-server path/to/server.ods-pilot.con.json

When the imported server uses Basic or M2M auth, the CLI import command prompts for the missing secret and stores it in the OS keyring if you provide one.

The three tabs

Query tab

Write JAQueL queries in a JSON editor and run them against the server. Results appear in a sortable table.

{ "Unit": {} }

Use Examples ▾ for ready-made patterns (filters, joins, aggregations) and History ▾ to re-run previous queries. Export any result with Ctrl+S.

🤖 AI-powered query parsing (optional) — If you install the AI dependencies and download a model, an AI input bar appears above the editor. Type a natural language query like "Show measurements Profile_* from last year" and the AI will parse it into structured conditions and generate the corresponding JAQueL query for preview before applying.

To enable AI features:

uv sync --extra ai  # installs openvino-genai and huggingface-hub
# Then download a model in Settings → AI Model Manager (coming in Phase 6)

Browse tab

Navigate the ODS data hierarchy without writing queries. Pick a root entity, add optional filter conditions, and click Query. Expand tree nodes to follow relations level by level. Click any instance to see its attributes on the right. The JAQueL query for the current view is shown in the preview panel.

Filter conditions are saved in ~/.ods-pilot/browse_conditions.json and persist across sessions.

Model tab

A read-only schema browser loaded from the ODS model on connect (no extra server calls). Entities are colour-coded by base type. Expand any entity to see its attributes (with data-type symbols) and relations (with cardinality). All enumerations and their index values are listed at the bottom.

Keyboard shortcuts

Documentation

• 🛠️ Developer guide — setup, project structure, tests, and CI
• 📝 Changelog

License

Apache License 2.0 — see LICENSE for details.