From 04a1ab0c654b2e7811a20e14c62b72260abb0c1d Mon Sep 17 00:00:00 2001 From: Jeffrey Phillips Freeman <jeffrey.freeman@syncleus.com> Date: Thu, 30 Jan 2020 21:40:16 +0100 Subject: [PATCH] Docs: Added some verbage to the readme. --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index 26d9c92..a3c7e34 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,37 @@ in PEP 492, and is therefore Python 3.5+ only. `aiogremlin` tries to follow `Gremlin-Python` as closely as possible both in terms of API and implementation. It is released according to the TinkerPop release schedule. +`aiogremlin`` is built directly on top of TinkerPop and allows access to all of the internals. This ensures all the +TinkerPop features are available to the end-user. The TinkerPop stack provides several tools which can be used to work +with `aiogremlin``. + +* **Gremlin**, a database agnostic query language for Graph Databases. +* **Gremlin Server**, a server that provides an interface for executing Gremlin on remote machines. +* a data-flow framework for splitting, merging, filtering, and transforming of data +* **Graph Computer**, a framework for running algorithms against a Graph Database. +* Support for both **OLTP** and **OLAP** engines. +* **TinkerGraph** a Graph Database and the reference implementation for TinkerPop. +* Native **Gephi** integration for visualizing graphs. +* Interfaces for most major Graph Compute Engines including **Hadoop M/R**. **Spark**, and **Giraph**. + +`aiogremlin` also supports any of the many databases compatible with TinkerPop including the following. + + * [JanusGraph](http://janusgraph.org/) + * [Titan](http://thinkaurelius.github.io/titan/) + * [Neo4j](http://neo4j.com) + * [OrientDB](http://www.orientechnologies.com/orientdb/) + * [MongoDB](http://www.mongodb.org) + * [Oracle NoSQL](http://www.oracle.com/us/products/database/nosql/overview/index.html) + * TinkerGraph + + Some unique feature provided by the Goblin OGM include: + +* High level asynchronous *Object Graph Mapper* (OGM) - provided by [goblin](http://git.qoto.org/goblin-ogm/goblin) +* Integration with the *official gremlin-python Gremlin Language Variant* (GLV) +* Native Python support for asynchronous programing including *coroutines*, *iterators*, and *context managers* as specified in [PEP 492](https://www.python.org/dev/peps/pep-0492/) +* *Asynchronous Python driver* for the Gremlin Server - now provided by [aiogremlin](http://aiogremlin.readthedocs.io/en/latest/) +* Async `Graph` implementation that produces *native Python GLV traversals* - now provided by [aiogremlin](http://aiogremlin.readthedocs.io/en/latest/) + ## Getting Started ```python -- GitLab