README.md 2.97 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)
4
[![Requirements](https://requires.io/github/goblin-ogm/aiogremlin/requirements.svg?branch=master)](https://requires.io/github/goblin-ogm/aiogremlin/requirements/?branch=master)
5
[![Codacy](https://api.codacy.com/project/badge/Grade/99c4b7d53ee94c85b95433ee4ff6230c)](https://www.codacy.com/gh/goblin-ogm/aiogremlin?utm_source=github.com&utm_medium=referral&utm_content=goblin-ogm/aiogremlin&utm_campaign=Badge_Grade)
6
[![codecov](https://codecov.io/gh/goblin-ogm/aiogremlin/branch/master/graph/badge.svg)](https://codecov.io/gh/goblin-ogm/aiogremlin)
7
8
9
10
11

[![PyPi](https://img.shields.io/pypi/v/aiogremlin.svg?style=flat)](https://pypi.python.org/pypi/aiogremlin)
[![Downloads](https://img.shields.io/pypi/dm/aiogremlin.svg?style=flat)](https://pypi.python.org/pypi/aiogremlin)
[![SemVer](https://img.shields.io/badge/SemVer-v2.0.0-green)](https://semver.org/spec/v2.0.0.html)
[![docs](https://readthedocs.org/projects/aiogremlin/badge/?version=latest)](https://aiogremlin.readthedocs.io/en/latest/)
12
[![Gitter](https://badges.gitter.im/Syncleus/aparapi.svg)](https://gitter.im/Syncleus/aparapi?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
davebshow's avatar
davebshow committed
13

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

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

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

davebshow's avatar
davebshow committed
24
25
Note that this *NOT* an official Apache project component, it is a
*THIRD PARTY PACKAGE!*
26

davebshow's avatar
davebshow committed
27
## Getting Started
davebshow's avatar
davebshow committed
28
29

```python
davebshow's avatar
davebshow committed
30
31
import asyncio
from aiogremlin import DriverRemoteConnection, Graph
davebshow's avatar
davebshow committed
32

33

davebshow's avatar
davebshow committed
34
loop = asyncio.get_event_loop()
35
36


davebshow's avatar
davebshow committed
37
38
39
40
41
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
42
  await remote_connection.close()
davebshow's avatar
davebshow committed
43
  return vertices
davebshow's avatar
davebshow committed
44

45

davebshow's avatar
davebshow committed
46
47
48
vertices = loop.run_until_complete(go(loop))
print(vertices)
# [v[1], v[2], v[3], v[4], v[5], v[6]]
49
```
50
51
52
53
54
55
56
57
58
59
60
61

## 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.