Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Object-oriented Python library to interact with Neo4j standalone REST server
Python Shell

README.rst 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.


Available throught Python Package Index:

$ pip install neo4jrestclient


$ easy_install neo4jrestclient

Getting started

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

>>> 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:

>>> n = gdb.nodes.create()

# Equivalent to
>>> n = gdb.node()

Specify properties for new node:

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

Accessing properties:

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

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

Create relationship:

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

Specify properties for new relationships:

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


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

Something went wrong with that request. Please try again.