You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tinkerpop.apache.org by sp...@apache.org on 2016/08/31 18:51:47 UTC

tinkerpop git commit: Update the README rst file for pypi

Repository: tinkerpop
Updated Branches:
  refs/heads/master c16be11d0 -> 01398b044


Update the README rst file for pypi

ugh - rst - super hurty............ CTR


Project: http://git-wip-us.apache.org/repos/asf/tinkerpop/repo
Commit: http://git-wip-us.apache.org/repos/asf/tinkerpop/commit/01398b04
Tree: http://git-wip-us.apache.org/repos/asf/tinkerpop/tree/01398b04
Diff: http://git-wip-us.apache.org/repos/asf/tinkerpop/diff/01398b04

Branch: refs/heads/master
Commit: 01398b0444d5eb15bf50160cccf0001c73c803b6
Parents: c16be11
Author: Stephen Mallette <sp...@genoprime.com>
Authored: Wed Aug 31 14:50:37 2016 -0400
Committer: Stephen Mallette <sp...@genoprime.com>
Committed: Wed Aug 31 14:51:34 2016 -0400

----------------------------------------------------------------------
 gremlin-python/src/main/jython/README | 27 ++++++++++++++++++++++++++-
 1 file changed, 26 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/tinkerpop/blob/01398b04/gremlin-python/src/main/jython/README
----------------------------------------------------------------------
diff --git a/gremlin-python/src/main/jython/README b/gremlin-python/src/main/jython/README
index 1fb3a8b..84ab9e8 100644
--- a/gremlin-python/src/main/jython/README
+++ b/gremlin-python/src/main/jython/README
@@ -15,4 +15,29 @@
 .. specific language governing permissions and limitations
 .. under the License.
 
-Apache TinkerPop - Gremlin Python
\ No newline at end of file
+=================================
+Apache TinkerPop - Gremlin Python
+=================================
+
+`Apache TinkerPop\u2122 <http://tinkerpop.apache.org>`_
+is a graph computing framework for both graph databases (OLTP) and
+graph analytic systems (OLAP). `Gremlin <http://tinkerpop.apache.org/gremlin.html>`_
+is the graph traversal language of
+TinkerPop. It can be described as a functional, data-flow language that enables users to succinctly express complex
+traversals on (or queries of) their application's property graph.
+
+Gremlin-Python implements Gremlin within the Python language and can be used on any Python virtual machine including
+the popular CPython machine. Python\u2019s syntax has the same constructs as Java including "dot notation" for function
+chaining ``(a.b.c)``, round bracket function arguments ``(a(b,c))```, and support for global namespaces
+``(a(b()) vs a(__.b()))```. As such, anyone familiar with Gremlin-Java will immediately be able to work with
+Gremlin-Python. Moreover, there are a few added constructs to Gremlin-Python that make traversals a bit more succinct.
+
+| >>> g.V().both()[1:3].toList()
+| [v[2], v[4]]
+| >>> g.V().both()[1].toList()
+| [v[2]]
+| >>> g.V().both().name.toList()
+| [lop, vadas, josh, marko, marko, josh, peter, ripple, lop, marko, josh, lop]
+
+Please see the `reference documentation <http://tinkerpop.apache.org/docs/current/reference/#gremlin-python>`_
+at Apache TinkerPop for more information on usage.
\ No newline at end of file