Skip to content

Commit fea81b6

Browse files
committed
Update README.md
1 parent 902e7cb commit fea81b6

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ sudo pip install python-arango
2121
- Latest (Supports up to ArangoDB Version 2.7)
2222

2323
```bash
24-
git clone https://github.com/Joowani/python-a.git
24+
git clone https://github.com/Joowani/python-arango.git
2525
cd python-arango
2626
python2.7 setup.py install
2727
```
@@ -289,13 +289,13 @@ my_db.graphs
289289
# Create a new graph
290290
my_graph = my_db.create_graph("my_graph")
291291

292-
# Create new vertex collections to a graph
292+
# Create new vertex collections for a graph
293293
my_db.create_collection("vcol01")
294294
my_db.create_collection("vcol02")
295295
my_graph.create_vertex_collection("vcol01")
296296
my_graph.create_vertex_collection("vcol02")
297297

298-
# Create a new edge definition to a graph
298+
# Create a new edge definition for a graph
299299
my_db.create_collection("ecol01", is_edge=True)
300300
my_graph.create_edge_definition(
301301
edge_collection="ecol01",
@@ -316,7 +316,7 @@ Vertex Management
316316
-----------------
317317

318318
```python
319-
# Create new vertices (again if "_key" is not given it's auto-generated)
319+
# Create new vertices (if "_key" is not given it's auto-generated)
320320
my_graph.create_vertex("vcol01", {"_key": "v01", "value": 1})
321321
my_graph.create_vertex("vcol02", {"_key": "v01", "value": 1})
322322

@@ -380,12 +380,12 @@ Batch Requests
380380
--------------
381381

382382
```python
383-
# NOTE: only CRUD methods for (documents/vertices/edges) are supported
383+
# NOTE: only CRUD methods for documents/vertices/edges are supported (WIP)
384384

385385
# Execute a batch request for managing documents
386386
my_db.execute_batch([
387387
(
388-
my_col.create_document, # method name
388+
my_col.create_document, # method name
389389
[{"_key": "doc04", "value": 1}], # args
390390
{"wait_for_sync": True} # kwargs
391391
),
@@ -510,7 +510,10 @@ a.server_time
510510
a.write_ahead_log
511511

512512
# Flush the write-ahead log
513-
a.flush_write_ahead_log(wait_for_sync=True, wait_for_gc=True)
513+
a.flush_write_ahead_log(
514+
wait_for_sync=True,
515+
wait_for_gc=True
516+
)
514517

515518
# Configure the write-ahead log
516519
a.set_write_ahead_log(
@@ -540,8 +543,10 @@ To Do
540543
4. Sharding
541544

542545

543-
Running Tests (requires ArangoDB on localhost)
546+
Running Tests
544547
----------------------------------------------
548+
The tests create temporary databases and users.
549+
If a test fails in the middle dummy elements should be cleaned up (WIP).
545550

546551
```bash
547552
nosetests-2.7 -v

0 commit comments

Comments
 (0)