odsbox-pilot 1.5.0

ASAM ODS desktop query tool powered by odsbox

odsbox-pilot

A desktop query tool for ASAM ODS servers, built on top of odsbox.

Features

• Connect to ASAM ODS servers with multiple auth modes (Basic, OIDC, M2M)
• Manage multiple server configurations with secure credential storage via keyring
• Interactive query editor with syntax highlighting (CodeMirror)
• Query history and built-in examples
• Tabular result display powered by pandas
• Browse tab: FilterTree-based ODS server navigation with lazy tree expansion, filter condition management, and attribute value discovery
• Model tab: read-only browser for the entity-relation schema — entities with attributes and relations, plus all enumerations

Requirements

• Python 3.14+
• A running ASAM ODS server

Installation

pip install odsbox-pilot[gui]

Usage

Launch without installing (always uses the latest release):

uvx odsbox-pilot[gui]@latest

Install as a persistent tool:

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

Or run as a module:

python -m odsbox_pilot

Browse tab

The Browse tab (second tab in the main window) lets you navigate the ODS server hierarchy interactively:

1. Filter Conditions — add conditions per entity (e.g., Project.name $like Elec*). Use the … button next to a value field to discover distinct values or the min/max range directly from the server. Conditions are persisted in ~/.ods-pilot/browse_conditions.json across sessions.
2. Root entity — select which entity type to query as the tree root, then click Query.
3. Tree — expand nodes to follow relations one level at a time. Each instance node shows related relation names; expanding a relation node fetches the connected instances.
4. Query Preview — shows the Jaquel query that will be (or was) sent to the server.

Model tab

The Model tab (third tab) displays the server's entity-relation schema read from the ODS model — no additional server calls are made after connecting.

• Entities — sorted by base name then application name, colour-coded by entity group (same colour scheme as the Browse tree). Expand an entity to see its Attributes (with ODS data-type symbols) and Relations (with cardinality, e.g. 1:n).
• Enumerations — all model enumerations with their items and index values.
• Property panel — selecting any tree node populates the right-hand panel with context-sensitive details: data type, target entity, inverse relation name, range, etc.

Development

This project uses uv for dependency management.

# Clone and set up — include the gui extra so wxpython is installed
git clone https://github.com/totonga/odsbox-pilot.git
cd odsbox-pilot
uv sync --extra gui

# Launch the app from source
uv run odsbox-pilot

# Alternative: run as a Python module
uv run python -m odsbox_pilot

# Run tests
uv run pytest tests/unit/

# Lint and type-check
uv run ruff check src/ tests/
uv run mypy src/

License

Apache License 2.0 — see LICENSE for details.