:Note: This library is no longer under active development. PRs to code and docs are still welcome, but new code will rarely if ever occur. If you are interested in taking over the maintainance of this library, please, contact me through a Github issue.

.. image:: https://travis-ci.org/versae/neo4j-rest-client.png?branch=master :target: https://travis-ci.org/versae/neo4j-rest-client

.. image:: https://coveralls.io/repos/versae/neo4j-rest-client/badge.png?branch=master :target: https://coveralls.io/r/versae/neo4j-rest-client?branch=master

.. image:: https://pypip.in/d/neo4jrestclient/badge.png :target: https://pypi.python.org/pypi/neo4jrestclient/ :alt: Downloads

Neo4j Python REST Client

:synopsis: Object-oriented Python library to interact with Neo4j standalone REST server.

The first objective of Neo4j Python REST Client is to make transparent for Python programmers the use of a local database through python-embedded_ or a remote database thanks to Neo4j REST Server. So, the syntax of this API is fully compatible with python-embedded. However, a new syntax is introduced in order to reach a more pythonic style.

Installation_

Available throught Python Package Index::

$ pip install neo4jrestclient

Or::

$ easy_install neo4jrestclient

Getting started_

The main class is GraphDatabase, exactly how in python-embedded_:

.. code:: python

from neo4jrestclient.client import GraphDatabase

gdb = GraphDatabase("http://localhost:7474/db/data/")

Due to the syntax is fully compatible with python-embedded_, the next lines only show the commands added and its differences.

Creating a node:

.. code:: python

n = gdb.nodes.create()

Equivalent to

n = gdb.node()

Specify properties for new node:

.. code:: python

n = gdb.nodes.create(color="Red", width=16, height=32)

Accessing properties:

.. code:: python

value = n['key'] # Get property value

n['key'] = value # Set property value

Create relationship:

.. code:: python

n1.relationships.create("Knows", n2) # Useful when the name of # relationship is stored in a variable

Specify properties for new relationships:

.. code:: python

n1.Knows(n2, since=123456789, introduced_at="Christmas party")

Documentation_

For the extended and latest version of the documentation, please, visit the read the docs_ site

.. _python-embedded: http://docs.neo4j.org/drivers/python-embedded/snapshot/ .. _lucene-querybuilder: http://github.com/scholrly/lucene-querybuilder .. _read the docs: http://readthedocs.org/docs/neo4j-rest-client/en/latest/ .. _Documentation: http://readthedocs.org/docs/neo4j-rest-client/en/latest/ .. _Installation: https://neo4j-rest-client.readthedocs.org/en/latest/info.html#installation .. _Getting started: https://neo4j-rest-client.readthedocs.org/en/latest/info.html#getting-started

.. image:: https://badges.gitter.im/Join%20Chat.svg :alt: Join the chat at https://gitter.im/versae/neo4j-rest-client :target: https://gitter.im/versae/neo4j-rest-client?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge