Merge pull request #63 from dothebart/addExampleSocialGraph

Add example social graph

Author: tariqdaouda

README.rst

@@ -278,3 +278,22 @@ pyArango collections have a caching system for documents that performs insertion
 
  #disable the cache
  humans.deactivateCache()
+
+Examples
+========
+More examples can be found in the examples directory.
+To try them out change the connection strings according to your local setup.
+
+Debian Dependency Graph
+-----------------------
+If you are on a Debian / Ubuntu you can install packages with automatic dependency resolution.
+In the end this is a graph. This example parses debian package files using the `deb_pkg_tools`,
+and will then create vertices and edges from packages and their relations.
+
+Use `examples/debiangraph.py` to install it, or `examples/fetchDebianDependencyGraph.py` to browse
+it as an ascii tree.
+
+ArangoDB Social Graph
+---------------------
+You can create the `ArangoDB SocialGraph <https://docs.arangodb.com/latest/Manual/Graphs/#the-social-graph>`_ using `examples/createSocialGraph.py`.
+It resemples `The original ArangoDB Javascript implementation <https://github.com/arangodb/arangodb/blob/devel/js/common/modules/%40arangodb/graph-examples/example-graph.js#L56>`_ in python.

examples/createSocialGraph.py

@@ -0,0 +1,61 @@
+#!/usr/bin/python
+import sys
+from pyArango.connection import *
+from pyArango.graph import *
+from pyArango.collection import *
+
+
+class Social(object):
+        class male(Collection) :
+            _fields = {
+                "name" : Field()
+            }
+            
+        class female(Collection) :
+            _fields = {
+                "name" : Field()
+            }
+            
+        class relation(Edges) :
+            _fields = {
+                "number" : Field()
+            }
+            
+        class social(Graph) :
+
+            _edgeDefinitions = (EdgeDefinition ('relation',
+                                                fromCollections = ["female", "male"],
+                                                toCollections = ["female", "male"]),)
+            _orphanedCollections = []
+
+
+        def __init__(self):
+               self.conn = Connection(username="USERNAME", password="SECRET")
+        
+               self.db = self.conn["_system"]
+               if self.db.hasGraph('social'):
+                   raise Exception("The social graph was already provisioned! remove it first")
+
+               self.female   = self.db.createCollection("female")
+               self.male     = self.db.createCollection("male")
+               
+               self.relation = self.db.createCollection("relation")
+               
+               g = self.db.createGraph("social")
+               
+               a = g.createVertex('female', {"name": 'Alice',  "_key": 'alice'});
+               b = g.createVertex('male',  {"name": 'Bob',    "_key": 'bob'});
+               c = g.createVertex('male',   {"name": 'Charly', "_key": 'charly'});
+               d = g.createVertex('female', {"name": 'Diana',  "_key": 'diana'});
+               a.save()
+               b.save()
+               c.save()
+               d.save()
+
+               g.link('relation', a, b, {"type": 'married', "_key": 'aliceAndBob'})
+               g.link('relation', a, c, {"type": 'friend', "_key": 'aliceAndCharly'})
+               g.link('relation', c, d, {"type": 'married', "_key": 'charlyAndDiana'})
+               g.link('relation', b, d, {"type": 'friend', "_key": 'bobAndDiana'})
+
+
+Social()

examples/debiangraph.py

@@ -29,7 +29,7 @@
 from pyArango.theExceptions import *
 
 # Configure your ArangoDB server connection here
-conn = Connection(arangoURL="http://localhost:8529", username="USERNAME", password="SECRET")
+conn = Connection(arangoURL="http://localhost:8529", username="root", password="")
 
 db = None
 edgeCols = {}

examples/fetchDebianDependencyGraph.py

@@ -0,0 +1,58 @@
+#!/usr/bin/python
+import sys
+from pyArango.connection import *
+from pyArango.graph import *
+from asciitree import *
+
+conn = Connection(username="USERNAME", password="SECRET")
+
+db = conn["ddependencyGrahp"]
+
+if not db.hasGraph('debian_dependency_graph'):
+    raise Exception("didn't find the debian dependency graph, please import first!")
+
+ddGraph = db.graphs['debian_dependency_graph']
+
+graphQuery = '''
+FOR package, depends, path IN
+    1..2 ANY
+     @startPackage Depends RETURN path
+'''
+
+startNode = sys.argv[1]
+
+bindVars =  { "startPackage": "packages/" + startNode }
+
+queryResult = db.AQLQuery(graphQuery, bindVars=bindVars, rawResults=True)
+
+# sub iterateable object to build up the tree for draw_tree:
+class Node(object):
+    def __init__(self, name, children):
+        self.name = name
+        self.children = children
+        
+    def getChild(self, searchName):
+        for child in self.children:
+            if child.name == searchName:
+                return child
+        return None
+    
+    def __str__(self):
+        return self.name
+
+def iteratePath(path, depth, currentNode):
+    pname = path[depth]['name']
+    subNode = currentNode.getChild(pname)
+    if subNode == None:
+        subNode = Node(pname, [])
+        currentNode.children.append(subNode)
+    if len(path) > depth + 1:
+        iteratePath(path, depth + 1, subNode)
+
+# Now we fold the paths substructure into the tree:
+rootNode = Node(startNode, [])
+for path in queryResult:
+    p = path['edges']
+    iteratePath(p, 0, rootNode)
+
+print draw_tree(rootNode)