HyperMesh Python SDK
The hypermesh distribution is a single, unified SDK that bundles:
- the embedded engine (
Connection) backed by the compiled core, - the remote client (
Client/AsyncClient) forhmdb serve, - analytics, universal ingestion, connectors, and reporting,
behind one curated, typed public API. Import it as:
import hypermesh as hmThe supported, stable surface is exactly what is exported in
hypermesh.__all__. Everything else is private and may change without notice.
Install matrix
Section titled “Install matrix”pip install the base SDK plus the extras you need. The embedded engine binary
ships inside the wheel, so no C toolchain is required.
| Goal | Install |
|---|---|
| Remote client only (pure-Python) | pip install hypermesh |
| Embedded local engine | pip install "hypermesh[engine]" |
| Analytics (numpy/scipy) | pip install "hypermesh[analytics]" |
| DataFrame bulk load | pip install "hypermesh[pandas]" |
| Parquet/Arrow paths | pip install "hypermesh[arrow]" |
| Run the REST server | pip install "hypermesh[server]" |
| S3 / cloud connectors | pip install "hypermesh[connectors]" |
| YAML mapping specs | pip install "hypermesh[yaml]" |
| Everything | pip install "hypermesh[all]" |
| Development | pip install "hypermesh[dev]" |
Supported platforms
Section titled “Supported platforms”Prebuilt wheels: CPython 3.11–3.13 on Linux manylinux2014 (x86_64 + aarch64);
macOS arm64 optional. Other platforms install from sdist (requires cc/make)
or use the remote client only.