Skip to content

Commit acde954

Browse files
committed
Update readme file
1 parent 7beeccd commit acde954

File tree

1 file changed

+43
-7
lines changed

1 file changed

+43
-7
lines changed

README.md

Lines changed: 43 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,38 @@ Mnemos is designed specifically for that shape of problem.
3232
- Capacity/eviction engine (`max_entries`, `max_bytes`) using deterministic delete commands.
3333
- Segment compaction with atomic directory swap.
3434
- gRPC service endpoint for remote clients.
35-
- Python typed client package with high-level `insert_text` / `query_text` APIs.
35+
- Python client package with high-level `MnemosMemory` (`store` / `ask`) and advanced typed APIs.
36+
37+
## Quickstart
38+
39+
One clear path from zero to first retrieval:
40+
41+
1. Start server.
42+
43+
```bash
44+
cd /Users/limemanas/Desktop/projects/Mnemos
45+
scripts/run_grpc.sh
46+
```
47+
48+
2. In another terminal, run Python quickstart.
49+
50+
```bash
51+
cd /Users/limemanas/Desktop/projects/Mnemos/python/mnemos-client
52+
python3 -m venv .venv
53+
source .venv/bin/activate
54+
python -m pip install --upgrade pip
55+
python -m pip install -e ".[dev]"
56+
./scripts/generate_proto.sh
57+
export MNEMOS_ADDR=127.0.0.1:50051
58+
export MNEMOS_NAMESPACE=quickstart-$(date +%s)
59+
python examples/simple_memory.py
60+
```
61+
62+
3. Optional: check live metrics.
63+
64+
```bash
65+
curl -s http://127.0.0.1:50052/metrics | head -n 40
66+
```
3667

3768
## Project Layout
3869

@@ -243,13 +274,14 @@ Package: `python/mnemos-client`
243274

244275
High-level developer API:
245276

246-
- `insert_text(...)`
247-
- `query_text(...)`
277+
- `MnemosMemory.store(...)`
278+
- `MnemosMemory.ask(...)`
248279

249-
Low-level API also available:
280+
Advanced typed API also available:
250281

251-
- `insert_memory(...)`
252-
- `query(...)`
282+
- `MnemosClient.remember(...)`
283+
- `MnemosClient.recall(...)`
284+
- `MnemosClient.query(...)`
253285

254286
Typical setup:
255287

@@ -260,9 +292,13 @@ source .venv/bin/activate
260292
python -m pip install --upgrade pip
261293
python -m pip install -e ".[dev]"
262294
./scripts/generate_proto.sh
263-
python examples/basic_usage.py
295+
python examples/simple_memory.py
264296
```
265297

298+
Function-by-function Python docs:
299+
300+
- `python/mnemos-client/README.md`
301+
266302
## Local Manual Demo
267303

268304
Run the Rust manual example:

0 commit comments

Comments
 (0)