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": "The Odyssey", "price": 25},
{"title": "The Iliad", "price": 18}
]
}""", "json")
doc.values('/books/*[/price:: > 20]/title::')
# ['The Odyssey']
doc.value('/books/*/price:: @| mean')
# 21.5
doc.records('/books/* | %(t = /title::; p = /price::)')
# [{'t': 'The Odyssey', 'p': 25}, {'t': 'The Iliad', 'p': 18}]
doc.plan('/books/*') # the static plan, as kaiv
doc.values('/books/*/title::', budget='nodes=1')
# ValueError: refused: the plan estimates 2 nodes; the budget allows 1
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.
1 maintainer
Metadata
1 maintainer
Release files for quarb 0.38.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| quarb-0.38.1.tar.gz | 1.9 MB | Details |
Built distributions (wheels)
| File | Reset | |||
|---|---|---|---|---|
| quarb-0.38.1-cp38-abi3-win_amd64.whl | CPython 3.8 | abi3 | Windows x86-64 | Details |
| quarb-0.38.1-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl | CPython 3.8 | abi3 | Linux glibc 2.17+ x86-64 | Details |
| quarb-0.38.1-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl | CPython 3.8 | abi3 | Linux glibc 2.17+ ARM64 | Details |
| quarb-0.38.1-cp38-abi3-macosx_11_0_arm64.whl | CPython 3.8 | abi3 | macOS 11.0+ ARM64 | Details |
| quarb-0.38.1-cp38-abi3-macosx_10_12_x86_64.whl | CPython 3.8 | abi3 | macOS 10.12+ x86-64 | Details |
Total release size: 79.3 MB
Release files / quarb-0.38.1.tar.gz
| Download URL | quarb-0.38.1.tar.gz |
|---|---|
| Size | 1.9 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
290a9fcf57d541e43116891a3869f35e8f2325689ad8e861374297f70c740a71
|
|
BLAKE2b-256 checksum How to use checksums |
2d986b8171e7604c1602897eda730c9e09e0e39b6080161227f544adadef67c2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logRelease files / quarb-0.38.1-cp38-abi3-win_amd64.whl
| Download URL | quarb-0.38.1-cp38-abi3-win_amd64.whl |
|---|---|
| Size | 15.8 MB |
| Tags | CPython 3.8 Windows x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
dcb8697455959b00ea2075d34039b6685af8f3d70cc3f3c1307af5107225b7f9
|
|
BLAKE2b-256 checksum How to use checksums |
43b62b90c1370b3eb1db988f734ec38f0a6677c2aba3c6194cec223efb017cbf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logRelease files / quarb-0.38.1-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
| Download URL | quarb-0.38.1-cp38-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl |
|---|---|
| Size | 16.3 MB |
| Tags | CPython 3.8 Linux glibc 2.17+ x86-64 abi3 |
|
SHA-256 checksum How to use checksums |
faac1690bd2e43ddf781e28079c92d59f9a0bad7f5ffb4207c644d334ba7a675
|
|
BLAKE2b-256 checksum How to use checksums |
68e8b345f307cf0218bc1edb3bc2d6880992cd3fc4357464a64a520a617e35fc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logRelease files / quarb-0.38.1-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
| Download URL | quarb-0.38.1-cp38-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl |
|---|---|
| Size | 15.3 MB |
| Tags | CPython 3.8 Linux glibc 2.17+ ARM64 abi3 |
|
SHA-256 checksum How to use checksums |
d357f5195045ddd1dbad2ba9874fb206d6a4dc292029d1a7fd49c119b00d04df
|
|
BLAKE2b-256 checksum How to use checksums |
5cebaf5e71586317d90c5fb0c85185655201ad0899d93cc1154416229ebccf5d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logRelease files / quarb-0.38.1-cp38-abi3-macosx_11_0_arm64.whl
| Download URL | quarb-0.38.1-cp38-abi3-macosx_11_0_arm64.whl |
|---|---|
| Size | 14.6 MB |
| Tags | CPython 3.8 abi3 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
556258b3a35a0880cc0b4241bb5bbf3112cbd1be88f9edae25105ddd297816a6
|
|
BLAKE2b-256 checksum How to use checksums |
c532eec5e2febee9c144086da6532387fc050991a911ee0ae27360257ee08905
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency logRelease files / quarb-0.38.1-cp38-abi3-macosx_10_12_x86_64.whl
| Download URL | quarb-0.38.1-cp38-abi3-macosx_10_12_x86_64.whl |
|---|---|
| Size | 15.3 MB |
| Tags | CPython 3.8 abi3 macOS 10.12+ x86-64 |
|
SHA-256 checksum How to use checksums |
46ff62cae9d3f8e64680d4530efaa59461eb0f5b70ea8f13a2ce6f7c52f43d73
|
|
BLAKE2b-256 checksum How to use checksums |
d81128a6318b4796d3e2e658353c464133a9edcea1fc88c073c638df4f875d0f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 15, 2026.
Transparency log
