Skip to content

Commit 14cd79c

Browse files
committed
Add setup.cfg and update README
1 parent 103b2a8 commit 14cd79c

File tree

2 files changed

+21
-15
lines changed

2 files changed

+21
-15
lines changed

README.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,28 @@
1-
Python-Arango
1+
python-arango
22
=========
33

44
Python Driver for ArangoDB REST API
55

6-
[![Build Status](https://travis-ci.org/joowani/python-arango.svg?branch=master)](https://travis-ci.org/joowani/python-arango)
7-
86
Overview
97
--------
108

11-
Python-Arango is a Python driver (2.7 and 3.4) for ArangoDB
12-
(<https://www.arangodb.com/>)
9+
Python-Arango is a Python driver for ArangoDB(<https://www.arangodb.com/>).
10+
11+
It is compatible with Python versions 2.7 and 3.4.
1312

1413
Installation
1514
------------
1615

17-
- Stable (Supports up to ArangoDB Version 2.7)
16+
- Stable (supports up to ArangoDB version 2.7.0)
1817

1918
```bash
2019
sudo pip install python-arango
2120
```
2221

23-
- Latest (Supports up to ArangoDB Version 2.7)
22+
- Latest (supports up to ArangoDB version 2.7.0)
2423

2524
```bash
26-
git clone https://github.com/Joowani/python-a.git
25+
git clone https://github.com/Joowani/python-arango.git
2726
cd python-arango
2827
python2.7 setup.py install
2928
```
@@ -291,13 +290,13 @@ my_db.graphs
291290
# Create a new graph
292291
my_graph = my_db.create_graph("my_graph")
293292

294-
# Create new vertex collections to a graph
293+
# Create new vertex collections for a graph
295294
my_db.create_collection("vcol01")
296295
my_db.create_collection("vcol02")
297296
my_graph.create_vertex_collection("vcol01")
298297
my_graph.create_vertex_collection("vcol02")
299298

300-
# Create a new edge definition to a graph
299+
# Create a new edge definition for a graph
301300
my_db.create_collection("ecol01", is_edge=True)
302301
my_graph.create_edge_definition(
303302
edge_collection="ecol01",
@@ -318,7 +317,7 @@ Vertex Management
318317
-----------------
319318

320319
```python
321-
# Create new vertices (again if "_key" is not given it's auto-generated)
320+
# Create new vertices (if "_key" is not given it's auto-generated)
322321
my_graph.create_vertex("vcol01", {"_key": "v01", "value": 1})
323322
my_graph.create_vertex("vcol02", {"_key": "v01", "value": 1})
324323

@@ -382,12 +381,12 @@ Batch Requests
382381
--------------
383382

384383
```python
385-
# NOTE: only CRUD methods for (documents/vertices/edges) are supported
384+
# NOTE: only CRUD methods for documents/vertices/edges are supported (WIP)
386385

387386
# Execute a batch request for managing documents
388387
my_db.execute_batch([
389388
(
390-
my_col.create_document, # method name
389+
my_col.create_document, # method name
391390
[{"_key": "doc04", "value": 1}], # args
392391
{"wait_for_sync": True} # kwargs
393392
),
@@ -512,7 +511,10 @@ a.server_time
512511
a.write_ahead_log
513512

514513
# Flush the write-ahead log
515-
a.flush_write_ahead_log(wait_for_sync=True, wait_for_gc=True)
514+
a.flush_write_ahead_log(
515+
wait_for_sync=True,
516+
wait_for_gc=True
517+
)
516518

517519
# Configure the write-ahead log
518520
a.set_write_ahead_log(
@@ -542,8 +544,10 @@ To Do
542544
4. Sharding
543545

544546

545-
Running Tests (requires ArangoDB on localhost)
547+
Running Tests
546548
----------------------------------------------
549+
The tests create temporary databases and users.
550+
If a test fails in the middle dummy elements should be cleaned up (WIP).
547551

548552
```bash
549553
nosetests-2.7 -v

setup.cfg

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
[bdist_wheel]
2+
universal = 1

0 commit comments

Comments
 (0)