README.md 3.25 KB
Newer Older
davebshow's avatar
davebshow committed
1
# [aiogremlin](https://pypi.python.org/pypi/aiogremlin/3.2.4)
2
[![tests](http://git.qoto.org/goblin-ogm/aiogremlin/badges/master/pipeline.svg)](http://git.qoto.org/goblin-ogm/aiogremlin/commits/master)
3
[![Requirements](https://requires.io/github/goblin-ogm/aiogremlin/requirements.svg?branch=master)](https://requires.io/github/goblin-ogm/aiogremlin/requirements/?branch=master)
4
[![test coverage](http://git.qoto.org/goblin-ogm/aiogremlin/badges/master/coverage.svg)](http://git.qoto.org/goblin-ogm/aiogremlin/commits/master)
5
[![codecov](https://codecov.io/gh/goblin-ogm/aiogremlin/branch/master/graph/badge.svg)](https://codecov.io/gh/goblin-ogm/aiogremlin)
6
[![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)
7
[![Scrutinizer](https://img.shields.io/scrutinizer/quality/g/goblin-ogm/aiogremlin/master.svg?style=flat)](https://scrutinizer-ci.com/g/goblin-ogm/aiogremlin)
8
9

[![PyPi](https://img.shields.io/pypi/v/aiogremlin.svg?style=flat)](https://pypi.python.org/pypi/aiogremlin)
10
[![Supported Versions](https://img.shields.io/pypi/pyversions/aiogremlin.svg?style=flat)](https://pypi.python.org/pypi/aiogremlin)
11
12
13
[![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/)
14
[![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
15

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

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

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

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

davebshow's avatar
davebshow committed
29
## Getting Started
davebshow's avatar
davebshow committed
30
31

```python
davebshow's avatar
davebshow committed
32
33
import asyncio
from aiogremlin import DriverRemoteConnection, Graph
davebshow's avatar
davebshow committed
34

35

davebshow's avatar
davebshow committed
36
loop = asyncio.get_event_loop()
37
38


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

47

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

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