annotate README.md @ 138:a0ba822690f4 default tip

don't read our own file-writes!
author drewp@bigasterisk.com
date Thu, 01 Jun 2023 14:04:06 -0700
parents 12bffd51450f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
91
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
1 # What's here
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
2
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
3 ## GraphFile
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
4
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
5 Connect a subgraph to a file, loading data from that file at starting, rewriting that file upon graph changes, and rereading it upon file changes (e.g. from your text editor).
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
6
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
7 ## SyncedGraph
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
8
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
9 An rdf graph container with these features:
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
10 - CurrentStateGraphApi: get a readonly rdflib.Graph-like
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
11 - GraphEditApi: higher-level API for editing the graph, including patchObject, patchSubgraph, patchMapping
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
12 - AutoDepGraphApi: experimental API that watches what graph reads your code makes, then calls your code again if those results would have changed (see knockoutjs, mobx, mopyx)
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
13
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
14 # Usage
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
15
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
16 Configure and run with your own launcher file like this:
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
17
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
18 ```
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
19 (look at demo.py)
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
20 ```
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
21
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
22 Then run like this:
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
23
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
24 ```
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
25 uvicorn launcher:app
12bffd51450f project config
drewp@bigasterisk.com
parents:
diff changeset
26 ```