Merge pull request #5 from topogram/v2

Merge changes for Topogram V1

Author: clemsos

.gitignore

@@ -1,3 +1,5 @@
+ARC5*
+
 venv
 *.oldies.py
 

README.md

@@ -20,6 +20,7 @@ topogram.create_topogram("test")
 
 Read the docs at [http://topogram.readthedocs.io/](http://topogram.readthedocs.io/)
 
+
 ## Install
 
     git clone https://github.com/topogram/topogram-api-client
@@ -29,76 +30,15 @@ Read the docs at [http://topogram.readthedocs.io/](http://topogram.readthedocs.i
 ## Example
 
 ```python
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-
-from topogram_client import TopogramAPIClient
-from random import randint
-
-# credentials
-TOPOGRAM_URL = "https://app.topogram.io" # http://localhost:3000
-USER = "[email protected]"
-PASSWORD = "password"
-
-
-# data
-NODES_COUNT = 5
-EDGES_COUNT = 8
-my_edges = []
-
-my_nodes = [{
-    "id": i,
-    "name" : "Node %s"%i
-} for i in range(0,NODES_COUNT)]
-
-for n in range(0,EDGES_COUNT):
-    src = randint(0,NODES_COUNT)
-    tgt = randint(0,NODES_COUNT)
-    edge = {
-        "source" : src,
-        "target" : tgt,
-        "weight" : 5,
-        "name" : "Edge from %s to %s"%(src, tgt)
-    }
-    my_edges.append(edge)
-
-# connect to the topogram instance
-topogram = TopogramAPIClient(TOPOGRAM_URL)
-
-# create a new user
-topogram.create_user(USER, PASSWORD)
-
-# login a new user if needed
-topogram.user_login(USER, PASSWORD)
-
-def create_topogram(title, nodes, edges):
-
-    print "Creating topogram '%s'"%title
-
-    r = topogram.create_topogram(title)
-    print r["message"]
-    topogram_ID = r["data"][0]["_id"]
-
-    # get and backup existing nodes and edges
-    existing_nodes = topogram.get_nodes(topogram_ID)["data"]
-    existing_edges = topogram.get_edges(topogram_ID)["data"]
-
-    # clear existing graph
-    topogram.delete_nodes([n["_id"] for n in existing_nodes])
-    print "nodes deleted"
-    topogram.delete_edges([n["_id"] for n in existing_edges])
-    print "edges deleted"
-
-    r = topogram.create_nodes(topogram_ID, nodes)
-    print "%s nodes created."%len(r["data"])
-    r = topogram.create_edges(topogram_ID, edges)
-    print "%s edges created."%len(r["data"])
-
-    print "done. Topogram has been updated. Check it at %s/topograms/%s/view"%(TOPOGRAM_URL, topogram_ID)
+from topogram-python-client import TopogramAPIClient
 
+topogram = TopogramAPIClient("http://localhost:3000")
 
+# create a new network
+topogram.create_topogram("My Topogram")
 create_topogram("Test", my_nodes, my_edges)
 ```
+See a complete example in [examples](./examples) folder
 
 ## command-line
 

docs/index.rst

@@ -3,8 +3,8 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Python API Client
-===============================================
+ Python API Client
+ ===============================================
 
 .. only:: html
 

examples/data/test_data_edges.csv

@@ -0,0 +1,21 @@
+source,target,weight
+1,9,4
+5,8,3
+7,3,1
+9,9,2
+9,3,2
+2,10,2
+10,8,1
+3,7,2
+10,8,2
+8,10,4
+10,5,2
+9,7,2
+7,8,2
+5,4,3
+10,6,4
+6,2,4
+7,10,1
+2,1,3
+2,7,1
+2,2,2

examples/data/test_data_nodes.csv

@@ -0,0 +1,11 @@
+id,name,lat,lng,weight,year_start,year_stop
+1,Stephanie,-6.7589,105.8671,20,2005,2008
+2,Teresa,47.7675,21.24,14,2006,2009
+3,Theresa,29.28065,105.70568,11,2005,2008
+4,Phyllis,-37.46025,-63.58537,11,2006,2010
+5,Ann,-6.23,106.0752,19,2006,2011
+6,Jennifer,-6.5465,105.8728,10,2007,2012
+7,Jacqueline,15.31667,-91.61667,11,2009,2010
+8,Julie,61.79682,25.70457,12,2008,2010
+9,Louise,61.19472,62.86889,10,2007,2009
+10,Wanda,-31.38333,-57.96667,19,2009,2012

examples/topogram.py

@@ -0,0 +1,94 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+from topogram_client import TopogramAPIClient
+from random import randint
+from csv import DictReader
+
+# credentials
+TOPOGRAM_URL = "http://localhost:3000" # "https://app.topogram.io"
+USER = "[email protected]"
+PASSWORD = "password"
+
+# data
+my_nodes = []
+my_edges = []
+
+with open('data/test_data_nodes.csv') as f :
+    reader = DictReader(f)
+    for n in reader :
+        node = {
+            "id" : n["id"],
+            "name" : n["name"],
+            "lat" : float(n["lat"]),
+            "lng" : float(n["lng"]),
+            "weight" : float(n["weight"]),
+            "start" : n["year_start"],
+            "end" : n["year_stop"]
+            }
+        my_nodes.append({ "data" : node })
+
+print my_nodes
+
+with open('data/test_data_edges.csv') as f :
+    reader = DictReader(f)
+    for e in reader :
+        edge = {
+            "source" : e["source"],
+            "target" : e["target"],
+            "weight" : float(e["weight"])
+        }
+        my_edges.append({ "data" : edge })
+
+# print my_edges
+
+def create_topogram(title, nodes, edges):
+
+    print "Creating topogram '%s'"%title
+
+    try :
+        r = topogram.create_topogram(title)
+    except ValueError:
+        print '> Topogram already exists'
+        r = topogram.get_topogram_by_name(title)
+
+    topogram_ID = r["data"]["_id"]
+    print "topogram ID : %s"%topogram_ID
+
+    # get and backup existing nodes and edges
+    existing_nodes = topogram.get_nodes(topogram_ID)["data"]
+    existing_edges = topogram.get_edges(topogram_ID)["data"]
+
+    # clear existing graph
+    if len(existing_nodes):
+        topogram.delete_nodes([n["_id"] for n in existing_nodes])
+        print "%s nodes deleted"%len(existing_nodes)
+    if len(existing_edges):
+        topogram.delete_edges([n["_id"] for n in existing_edges])
+        print "%s edges deleted"%len(existing_edges)
+
+    r = topogram.create_nodes(topogram_ID, nodes)
+    print r
+    print "%s nodes created."%len(r["data"])
+    r = topogram.create_edges(topogram_ID, edges)
+    print "%s edges created."%len(r["data"])
+
+    print "done. Topogram has been updated. Check it at %s/topograms/%s"%(TOPOGRAM_URL, topogram_ID)
+
+# connect to the topogram instance (pass debug=True params for more info )
+topogram = TopogramAPIClient(TOPOGRAM_URL) #, debug=True)
+
+# create a new user
+try :
+    topogram.create_user(USER, PASSWORD)
+except ValueError:
+    print "> User has already been created."
+
+# login a new user if needed
+resp_user_login = topogram.user_login(USER, PASSWORD)
+print resp_user_login
+
+assert(resp_user_login["status"] == "success")
+assert(resp_user_login["status_code"] == 200)
+
+create_topogram("Geo-time network", my_nodes, my_edges)