Skip to content

Commit e72026c

Browse files
authored
Merge branch 'master' into v2
2 parents 7cd2b87 + ef8a70f commit e72026c

File tree

1 file changed

+28
-5
lines changed

1 file changed

+28
-5
lines changed

README.md

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,41 @@
44

55
A python lib to communicate with Topogram
66

7+
## How it works
78

89

9-
## How it works
10+
```python
11+
from topogram-python-client import TopogramAPIClient
12+
13+
topogram = TopogramAPIClient("http://localhost:3000")
14+
15+
# create a new network
16+
topogram.create_topogram("test")
17+
```
18+
19+
## Documentation
1020

1121
Read the docs at [http://topogram.readthedocs.io/](http://topogram.readthedocs.io/)
1222

13-
from topogram-python-client import TopogramAPIClient
1423

15-
topogram = TopogramAPIClient("http://localhost:3000")
24+
## Install
25+
26+
git clone https://github.com/topogram/topogram-api-client
27+
cd topogram-api-client
28+
python setup.py install
29+
30+
## Example
31+
32+
```python
33+
from topogram-python-client import TopogramAPIClient
34+
35+
topogram = TopogramAPIClient("http://localhost:3000")
1636

17-
# create a new network
18-
topogram.create_topogram("test")
37+
# create a new network
38+
topogram.create_topogram("My Topogram")
39+
create_topogram("Test", my_nodes, my_edges)
40+
```
41+
See a complete example in [examples](./examples) folder
1942

2043
## command-line
2144

0 commit comments

Comments
 (0)