README.md 1.82 KB
Newer Older
davebshow's avatar
davebshow committed
1
# [aiogremlin](https://pypi.python.org/pypi/aiogremlin/3.2.4)
2
3
[![tests](http://git.qoto.org/goblin-ogm/aiogremlin/badges/master/pipeline.svg)](http://git.qoto.org/goblin-ogm/aiogremlin/commits/master)
[![test coverage](http://git.qoto.org/goblin-ogm/aiogremlin/badges/master/coverage.svg)](http://git.qoto.org/goblin-ogm/aiogremlin/commits/master)
davebshow's avatar
davebshow committed
4

davebshow's avatar
davebshow committed
5
[Official Documentation](http://aiogremlin.readthedocs.org/en/latest/)
davebshow's avatar
davebshow committed
6

7
`aiogremlin` is an asynchronous DSL based on the official `Gremlin-Python` GLV designed for integration with
davebshow's avatar
davebshow committed
8
event loop based asynchronous Python networking libraries, including `asyncio`,
davebshow's avatar
davebshow committed
9
`aiohttp`, and `tornado`. It uses the `async/await` syntax introduced
davebshow's avatar
davebshow committed
10
in PEP 492, and is therefore Python 3.5+ only.
davebshow's avatar
davebshow committed
11

davebshow's avatar
davebshow committed
12
`aiogremlin` tries to follow `Gremlin-Python` as closely as possible both in terms
13
of API and implementation. It is released according to the TinkerPop release schedule.
davebshow's avatar
davebshow committed
14

davebshow's avatar
davebshow committed
15
16
Note that this *NOT* an official Apache project component, it is a
*THIRD PARTY PACKAGE!*
17

davebshow's avatar
davebshow committed
18
## Getting Started
davebshow's avatar
davebshow committed
19
20

```python
davebshow's avatar
davebshow committed
21
22
import asyncio
from aiogremlin import DriverRemoteConnection, Graph
davebshow's avatar
davebshow committed
23

24

davebshow's avatar
davebshow committed
25
loop = asyncio.get_event_loop()
26
27


davebshow's avatar
davebshow committed
28
29
30
31
32
async def go(loop):
  remote_connection = await DriverRemoteConnection.open(
    'ws://localhost:8182/gremlin', 'g')
  g = Graph().traversal().withRemote(remote_connection)
  vertices = await g.V().toList()
davebshow's avatar
davebshow committed
33
  await remote_connection.close()
davebshow's avatar
davebshow committed
34
  return vertices
davebshow's avatar
davebshow committed
35

36

davebshow's avatar
davebshow committed
37
38
39
vertices = loop.run_until_complete(go(loop))
print(vertices)
# [v[1], v[2], v[3], v[4], v[5], v[6]]
40
```
41
42
43
44
45
46
47
48
49
50
51
52

## Developers

### Testing

In order to perform tests identical in nature to the integration tests we run then simply ensure you gave gitlab-runner installed then run the following command.

```bash
gitlab-runner exec docker test
```

Keep in mind this will run the tests on your local copy of the master branch so any changes not committed locally will be missed when testing.