Skip to content

Commit ded922d

Browse files
committed
ci: add README.md for coordinode-embedded (maturin requires it)
1 parent 736fe7a commit ded922d

1 file changed

Lines changed: 42 additions & 0 deletions

File tree

coordinode-embedded/README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# coordinode-embedded
2+
3+
In-process CoordiNode graph database for Python — no server, no Docker required.
4+
5+
```python
6+
from coordinode_embedded import LocalClient
7+
8+
with LocalClient(":memory:") as db:
9+
db.cypher("CREATE (n:Person {name: $name})", {"name": "Alice"})
10+
rows = db.cypher("MATCH (n:Person) RETURN n.name AS name")
11+
print(rows) # [{"name": "Alice"}]
12+
```
13+
14+
## Installation
15+
16+
```bash
17+
pip install coordinode-embedded
18+
```
19+
20+
## Usage
21+
22+
`LocalClient` is a drop-in replacement for `CoordinodeClient` for local development,
23+
notebooks (Jupyter, Google Colab), and testing — same `.cypher()` API, zero infrastructure.
24+
25+
```python
26+
from coordinode_embedded import LocalClient
27+
28+
# In-memory (discarded on close)
29+
with LocalClient(":memory:") as db:
30+
db.cypher("CREATE (n:Person {name: 'Alice'})")
31+
rows = db.cypher("MATCH (n:Person) RETURN n.name AS name")
32+
33+
# Persistent storage
34+
db = LocalClient("/path/to/db")
35+
db.cypher("CREATE (n:Item {id: 1})")
36+
db.close()
37+
```
38+
39+
## Links
40+
41+
- [CoordiNode](https://github.com/structured-world/coordinode) — the graph database engine
42+
- [coordinode-python](https://github.com/structured-world/coordinode-python) — Python SDK

0 commit comments

Comments
 (0)