quarb

Python bindings for the Quarb query engine — import quarb, plus qua, its command-line face. Quarb reads structured text as an arbor — a tree-spanned graph — and runs one query language over all of it, generalizing what XPath does for XML and jq does for JSON to JSON, YAML, TOML, CSV/TSV, XML, HTML, and Markdown alike. Try it live in the playground.

Install

pip install quarb

This installs the quarb Python module and the qua command (the language is Quarb; qua is its CLI).

Wheels are published for Linux (x86_64, aarch64), macOS (arm64, x86_64), and Windows (x86_64). The extension is built against PyO3's stable ABI (abi3-py38); a single wheel covers CPython 3.8 and later.

The qua command

The entry point covers what the bindings cover — one query over a text document:

qua '/books/*[/price:: > 20]/title::' store.json
echo '{"users":[{"name":"ada"}]}' | qua -f json '/users/*/name::'

Beyond text, quarb.open(path) dispatches on kind over the full local fleet — SQLite, kaiv (typed units), the filesystem (descend=True grafts parseable leaves), git (git:PATH), archives, XLSX, and source code — and quarb.mount([a, b, ...]) mounts several sources under one root so a single query joins across them (a YAML file <=> a SQLite database). The networked adapters — Postgres, MySQL, BigQuery, Neo4j, object stores, mail — and DuckDB live in the Rust binary: cargo install qua.

Quick start

import quarb

doc = quarb.loads("""{
  "books": [
    {"title": "Sapiens", "price": 25},
    {"title": "Cosmos",  "price": 18}
  ]
}""", "json")

doc.values('/books/*[/price:: > 20]/title::')
# ['Sapiens']

doc.value('/books/*/price:: @| mean')
# 21.5

doc.records('/books/* | %(t = /title::; p = /price::)')
# [{'t': 'Sapiens', 'p': 25}, {'t': 'Cosmos', 'p': 18}]

loads(text, format) / load(path) parse once into a Document, queried many times. Results come back typed: ints, floats, strings, None for null, tz-aware datetime for instants, timedelta for durations, Quantity for unit-carrying values, dicts for records. Formats: json, yaml, toml, csv, tsv, xml, html, markdown.

The lower-level quarb.run(query, text, format) and quarb.run_file(query, path) return the result lines as strings — exactly what the qua CLI prints. All errors raise ValueError with the engine's message.

For the query language itself — steps, criteria, readings, patterns, joins — see the user guide and spec.

License

Licensed under either of Apache License, Version 2.0 or the MIT license at your option. Both texts are bundled in the package.

Jupyter

%load_ext quarb.ipython
%quarb_mount fleet.daiv
%quarb /@hosts/*[::power > 0.2kW]::name

%%quarb [NAME] runs a cell-sized query against a named mount; results render as HTML tables, iterate as typed values (quantities keep magnitude + unit), and convert with .df / .df_magnitudes().

For a notebook where every cell is a query, install the dedicated kernel and pick Quarb in the launcher:

python -m quarb.kernel install
python -m quarb.kernel demo      # writes quarb-demo.ipynb to try

Cells are queries; %mount, %connect, %use, %docs, %translate, and %python (an escape hatch — the rest of the cell is Python, with the live session and the last result _ in scope) are the directives. Tab-completion offers the mounted arbor's real child names, and the bundled JupyterLab extension highlights Quarb syntax in cells automatically. %connect NAME PATH... (magic: %quarb_connect) attaches to a qua --resident daemon — for arbors too large to rebuild per notebook, queried from a standing session. pip install quarb[jupyter] pulls IPython, pandas, and the kernel runtime.

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.29.0)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for deyanovich from gravatar.com deyanovich

Credits

Author: Bojan Đuričković

License expression

MIT OR Apache-2.0
View SPDX License List

Requires

Python >=3.8

Provides Extra

jupyter

Tags

query quarb json yaml csv xpath jq

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

quarb-0.28.0.tar.gz (953.9 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

quarb-0.28.0-cp38-abi3-win_amd64.whl (10.6 MB view details)

Uploaded CPython 3.8+Windows x86-64

quarb-0.28.0-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (11.0 MB view details)

Uploaded CPython 3.8+manylinux: glibc 2.17+ x86-64

quarb-0.28.0-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl (10.4 MB view details)

Uploaded CPython 3.8+manylinux: glibc 2.17+ ARM64

quarb-0.28.0-cp38-abi3-macosx_11_0_arm64.whl (9.8 MB view details)

Uploaded CPython 3.8+macOS 11.0+ ARM64

quarb-0.28.0-cp38-abi3-macosx_10_12_x86_64.whl (10.3 MB view details)

Uploaded CPython 3.8+macOS 10.12+ x86-64

File details

Details for the file quarb-0.28.0.tar.gz.

File metadata

  • Download URL: quarb-0.28.0.tar.gz
  • Upload date:
  • Size: 953.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for quarb-0.28.0.tar.gz
Algorithm Hash digest
SHA256 c61d5dfc974639eb1e3b6fe94782354c4527480b60eea7b5dae87daf72812d6f
MD5 f8d0cebba5224429a9165fc2fcee07b7
BLAKE2b-256 dc7a5055889f9285c1078df03cb97bbb0a0b5ad74eab0e1d684fbba6bf381c1f

See more details on using hashes here.

Provenance

The following attestation bundles were made for quarb-0.28.0.tar.gz:

Publisher: publish-pypi.yml on deyanovich/quarb-rs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file quarb-0.28.0-cp38-abi3-win_amd64.whl.

File metadata

  • Download URL: quarb-0.28.0-cp38-abi3-win_amd64.whl
  • Upload date:
  • Size: 10.6 MB
  • Tags: CPython 3.8+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for quarb-0.28.0-cp38-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 6d348a1208ac880971f9c8c9a1f76b14cfb3e476a793cf8a296e8b84986528a1
MD5 ecd2391d0b5082ab63c3ecd60f683722
BLAKE2b-256 5c8ca33d3b0a51b115d99c1319b68578d4983b939e57ed9e4ba5817601cd0ffe

See more details on using hashes here.

Provenance

The following attestation bundles were made for quarb-0.28.0-cp38-abi3-win_amd64.whl:

Publisher: publish-pypi.yml on deyanovich/quarb-rs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file quarb-0.28.0-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.

File metadata

File hashes

Hashes for quarb-0.28.0-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Algorithm Hash digest
SHA256 bba1da031684cffdfea929e41f9ad9a671205b50eef09ef7d154f915291ffe0c
MD5 5e2d089134cf63ed39b519530a55dc7e
BLAKE2b-256 39e44691e49f690352e7f241e9e09d3d8f3aefe11d00ab81d86298469a433636

See more details on using hashes here.

Provenance

The following attestation bundles were made for quarb-0.28.0-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl:

Publisher: publish-pypi.yml on deyanovich/quarb-rs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file quarb-0.28.0-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl.

File metadata

File hashes

Hashes for quarb-0.28.0-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Algorithm Hash digest
SHA256 b3cf773dc7419fafa276042a394b1118efea00b3872c7601616e06725ce5dad2
MD5 7b119cbc059843d84b3fa1f60811b294
BLAKE2b-256 e9c129aa1bfec01714c527570f239ac5655278b0c133498cef36f7f21b84d207

See more details on using hashes here.

Provenance

The following attestation bundles were made for quarb-0.28.0-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl:

Publisher: publish-pypi.yml on deyanovich/quarb-rs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file quarb-0.28.0-cp38-abi3-macosx_11_0_arm64.whl.

File metadata

File hashes

Hashes for quarb-0.28.0-cp38-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 cbc248b5be93de081f4cf9c7cca5512083a823e43e41f4e2750872f0c2ce9d86
MD5 97fffdf69dbf6066af72f3c9f614fd95
BLAKE2b-256 0094849008cf31b09ecffb2bad7dc3e4cd59e8152119c77ab2133e077bb2e99f

See more details on using hashes here.

Provenance

The following attestation bundles were made for quarb-0.28.0-cp38-abi3-macosx_11_0_arm64.whl:

Publisher: publish-pypi.yml on deyanovich/quarb-rs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file quarb-0.28.0-cp38-abi3-macosx_10_12_x86_64.whl.

File metadata

File hashes

Hashes for quarb-0.28.0-cp38-abi3-macosx_10_12_x86_64.whl
Algorithm Hash digest
SHA256 b0f9ad1084623b75a846cb07fefa2f1056a28d0b2d8731278e24b2ec012597f6
MD5 7258aaa8fec3f23cb75d14feba8c9b52
BLAKE2b-256 e382dbc249a8f585ac9ee200821f91ec522b9517c39ec10f900cdaf742402d20

See more details on using hashes here.

Provenance

The following attestation bundles were made for quarb-0.28.0-cp38-abi3-macosx_10_12_x86_64.whl:

Publisher: publish-pypi.yml on deyanovich/quarb-rs

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.29.0

6 files

This release

0.28.0 This release

6 files

0.27.0

6 files

0.26.0

6 files

0.25.0

6 files

0.24.0

6 files

0.23.0

6 files

0.22.0

6 files

0.21.0

6 files

0.20.0

6 files

0.19.0

6 files

0.18.0

6 files

0.17.0

6 files

0.16.0

6 files

0.15.0

6 files

0.14.0

6 files

0.13.0

6 files

0.12.0

6 files

0.11.0

6 files

0.10.0

6 files

0.9.0

6 files

0.6.0

6 files

0.5.0

6 files

0.4.0

6 files

0.3.6

6 files

0.3.5

6 files

0.3.4

6 files

0.3.3

6 files

0.3.2

6 files

0.3.1

6 files

0.3.0

6 files

0.2.0

6 files

0.1.1

6 files

0.1.0

6 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page