Skip to content

Commit c3aae04

Browse files
authored
Merge pull request #2 from runtimed/doc-updatews
clean up docs a bit
2 parents 38df88f + f3a02b1 commit c3aae04

File tree

5 files changed

+18
-28
lines changed

5 files changed

+18
-28
lines changed

AGENTS.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ agent library.
66
## Project Overview
77

88
Runt is a TypeScript/Deno library for building runtime agents that connect to
9-
Anode notebooks. It uses LiveStore for event-sourcing and real-time sync between
10-
multiple users.
9+
[Anode notebooks](https://github.com/rgbkrk/anode). It uses LiveStore for
10+
event-sourcing and real-time sync between multiple users.
1111

1212
**Current Status**: Working system with 29 passing tests. Core functionality is
1313
implemented and published to JSR. The system is a working prototype with Python
@@ -110,7 +110,8 @@ not queried during materialization.
110110
**Import errors**: Make sure all imports use the workspace aliases
111111
(`@runt/schema`, `@runt/lib`) or relative paths correctly.
112112

113-
**Test permissions**: Tests need `--allow-env --allow-net --allow-read` flags.
113+
**Test permissions**: Tests need
114+
`--allow-env --allow-net --allow-read --allow-write --allow-sys` flags.
114115

115116
**Publishing**: Requires `--allow-slow-types` flag due to LiveStore's complex
116117
types.
@@ -124,9 +125,8 @@ don't return data from the execution handler.
124125
- **Integration tests**: Cross-package interactions in `test/`
125126
- **Example tests**: Ensure examples work in `examples/`
126127

127-
Run tests with: `deno test --allow-env --allow-net --allow-read`
128-
129-
Current test count: 29 passing, 0 failing
128+
Run tests with:
129+
`deno test --allow-env --allow-net --allow-read --allow-write --allow-sys`
130130

131131
## Dependencies
132132

README.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,14 @@
11
# Runt
22

3-
Runtime agents for connecting to notebooks. Deno/TypeScript prototype using
4-
LiveStore for event-sourcing and real-time sync.
5-
6-
Working system with end-to-end Python execution. Deno/TypeScript prototype.
3+
Runtime agents for connecting to next gen notebooks from
4+
[Anode](https://github.com/rgbkrk/anode).
75

86
## Packages
97

108
- `@runt/schema` - LiveStore schema (events, tables, types)
119
- `@runt/lib` - Runtime agent base class
1210
- `@runt/pyodide-runtime-agent` - Python runtime using Pyodide
1311

14-
## Status
15-
16-
What works:
17-
18-
- Python code execution via Pyodide
19-
- Jupyter-compatible outputs (stdout, stderr, rich displays)
20-
- LiveStore event-sourcing and sync
21-
- CLI configuration
22-
- Real-time collaboration
23-
2412
## Usage
2513

2614
```bash

packages/lib/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# @runt/lib
22

3-
Runtime agent base class. Connects to LiveStore, processes execution queues,
4-
handles outputs.
3+
Runtime agent base class. Connects to [Anode](https://github.com/rgbkrk/anode),
4+
processes execution queues, handles outputs.
55

66
## Usage
77

@@ -37,7 +37,7 @@ await agent.keepAlive();
3737

3838
```bash
3939
--notebook <id> # Required
40-
--auth-token <token> # Required
40+
--auth-token <token> # Required
4141
--kernel-type <type> # Optional
4242
--sync-url <url> # Optional
4343
```

packages/pyodide-runtime-agent/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
Python runtime using Pyodide. Prototype implementation with IPython integration.
44

5+
Goes well beyond the initial [Anode](https://github.com/rgbkrk/anode) runtime implementation (for Python at least...).
6+
57
## Usage
68

79
```typescript
810
import { PyodideRuntimeAgent } from "@runt/pyodide-runtime-agent";
9-
const agent = new PyodideRuntimeAgent(Deno.args);
11+
const agent = new PyodideRuntimeAgent(Deno.args); // presuming we got --notebook=NOTEBOOK_ID, etc.
1012
await agent.start();
1113
await agent.keepAlive();
1214
```
@@ -16,7 +18,7 @@ Works:
1618
- Python execution via Pyodide
1719
- Rich outputs (HTML, pandas tables, matplotlib SVG)
1820
- IPython display system
19-
- Essential packages pre-loaded
21+
- Basic Scientific computing stack pre-loaded
2022
- Code interruption
2123

2224
CLI: `--notebook <id> --auth-token <token>` (required)
@@ -31,9 +33,9 @@ Notes:
3133
## Pre-loaded Packages
3234

3335
Data: numpy, pandas, polars, pyarrow, duckdb
34-
Viz: matplotlib, bokeh, altair\
36+
Viz: matplotlib, bokeh, altair
3537
Science: scipy, sympy, scikit-learn, statsmodels
36-
Utils: requests, rich, beautifulsoup4, pillow, geopandas, networkx
38+
Misc: requests, rich, beautifulsoup4, pillow, geopandas, networkx
3739

3840
## Example
3941

packages/schema/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @runt/schema
22

3-
LiveStore schema for notebooks. Events, tables, and types.
3+
LiveStore schema for anode notebooks. Events, tables, and types.
44

55
```typescript
66
import { events, schema, tables } from "jsr:@runt/schema";

0 commit comments

Comments
 (0)