diff lib/patchablegraph/README.md @ 1320:6a910da391e6

packaging and readme Ignore-this: 42e3e426a625ee79d4f25c94c7b21f35 darcs-hash:88ccca6adc930c9fac15276da67a7fa9ad935992
author drewp <drewp@bigasterisk.com>
date Tue, 23 Apr 2019 00:10:41 -0700
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/lib/patchablegraph/README.md	Tue Apr 23 00:10:41 2019 -0700
@@ -0,0 +1,29 @@
+RDF graph that accepts patches and serves them over HTTP (with a SSE protocol).
+
+Example:
+
+```
+from patchablegraph import PatchableGraph
+
+masterGraph = PatchableGraph()
+
+```
+
+Then, you call `masterGraph.patch`, etc to edit the
+graph. `rdfdb.grapheditapi.GraphEditApi` is mixed in, so you can
+use
+[higher-level functions](https://bigasterisk.com/darcs/?r=rdfdb;a=headblob;f=/rdfdb/grapheditapi.py) from
+there, such as patchObject.
+
+Web serving:
+
+``` from patchablegraph import CycloneGraphHandler,
+CycloneGraphEventsHandler
+
+reactor.listenTCP(9059, cyclone.web.Application([
+    ...
+    (r"/graph", CycloneGraphHandler, {'masterGraph': masterGraph}),
+    (r"/graph/events", CycloneGraphEventsHandler, {'masterGraph': masterGraph}),
+    ...
+```
+