You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update CONTRIBUTORS.md and README.md to include Python DSL support
This commit enhances the documentation by adding support for the Python DSL in both the CONTRIBUTORS.md and README.md files. The changes reflect the addition of Python as a query authoring option alongside Rust, TypeScript, and Go, and provide examples for using the Python client to build and send dynamic requests. This update improves clarity and accessibility for users utilizing the Python SDK.
Copy file name to clipboardExpand all lines: CONTRIBUTORS.md
+4-3Lines changed: 4 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -190,7 +190,7 @@ The v3 CLI is a runtime orchestrator — there is no `helix compile`/`helix chec
190
190
191
191
1. Scaffold a project with `helix init` (writes `helix.toml` and a `.helix/` workspace).
192
192
2. Start a local instance with `helix start` — a Docker/Podman container running the `enterprise-dev` image (in-memory by default, on-disk with `--disk`).
193
-
3. Author queries with the Rustor TypeScript DSL; they serialize to JSON "dynamic queries".
193
+
3. Author queries with the Rust, TypeScript, Go, or Python DSL; they serialize to JSON "dynamic queries".
194
194
4. Send queries to a running instance via `POST /v1/query` (`helix query`); validation happens server-side.
195
195
5. For production, deploy an Enterprise Cloud instance with `helix push`, managing auth/metadata via `helix auth`, `helix sync`, and the `workspace`/`project`/`cluster` commands.
196
196
@@ -201,6 +201,7 @@ Client libraries that build HelixDB queries and send them to a running instance.
201
201
-`rust/` - Rust DSL builder (crate `helix-db`), with the `helix-dsl-macros` procedural-macro crate
-`python/` - Python client and DSL (`helix-db`, imported as `helixdb`)
204
205
-`tests/` - Cross-SDK parity tests and metadata registration tests
205
206
206
207
#### `/metrics/` - Metrics
@@ -212,7 +213,7 @@ Logos and images used in the README and docs.
212
213
## Key Concepts
213
214
214
215
### Query Language
215
-
Queries are authored with the Rustor TypeScript DSL (in `sdks/`) and serialized to JSON "dynamic queries" sent to a running instance. The legacy HelixQL `.hx` form below is still supported for reference and translation:
216
+
Queries are authored with the Rust, TypeScript, Go, or Python DSL (in `sdks/`) and serialized to JSON "dynamic queries" sent to a running instance. The legacy HelixQL `.hx` form below is still supported for reference and translation:
Copy file name to clipboardExpand all lines: README.md
+48-2Lines changed: 48 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -78,7 +78,7 @@ If you'd rather wire things up yourself:
78
78
79
79
## Writing queries with the SDKs
80
80
81
-
Queries are authored with the Rustor TypeScript DSL and sent straight to a running instance as dynamic requests against `POST /v1/query` — no build or deploy step. Both SDKs produce the same JSON AST. The examples below talk to a local instance on `http://localhost:6969` (the default `helix start dev` port). See the [Querying Guide](https://docs.helix-db.com/database/querying-guide/overview) for the full builder catalog and the dynamic-query wire format.
81
+
Queries are authored with the Rust, TypeScript, Go, or Python DSL and sent straight to a running instance as dynamic requests against `POST /v1/query` — no build or deploy step. The SDKs produce the same JSON AST. The examples below talk to a local instance on `http://localhost:6969` (the default `helix start dev` port). See the [Querying Guide](https://docs.helix-db.com/database/querying-guide/overview) for the full builder catalog and the dynamic-query wire format.
82
82
83
83
### Rust
84
84
@@ -197,6 +197,52 @@ const user = await fetch(HELIX_URL, {
197
197
console.log("user:", user);
198
198
```
199
199
200
+
### Python
201
+
202
+
Install the package from this repository:
203
+
204
+
```bash
205
+
pip install -e sdks/python
206
+
```
207
+
208
+
Build dynamic requests with snake_case builders, then send them with the client:
209
+
210
+
```python
211
+
from helixdb import Client, Predicate, g, param, define_params, read_batch, write_batch
HelixDB Cloud is an object-storage-backed deployment with integrated vector and full-text search, full ACID transactions, a single writer with auto-scaling reader nodes, and high availability (3+ gateways and DB nodes). Cloud clusters use a separate deploy path from local instances:
@@ -224,4 +270,4 @@ HelixDB is available as a distributed, high-availability, managed service. If yo
0 commit comments