The Py2neo v4 Handbook

Py2neo is a client library and toolkit for working with Neo4j from within Python applications and from the command line. The library supports both Bolt and HTTP and provides a high level API, an OGM, admin tools, an interactive console, a Cypher lexer for Pygments, and many other bells and whistles. Unlike previous releases, Py2neo v4 no longer requires an HTTP-enabled server and can work entirely through Bolt.

Note

Documentation for Py2neo v3 is available here.

Installation

To install the latest stable version of py2neo, simply use pip:

$ pip install py2neo

To install the latest bleeding edge code directly from GitHub, use:

$ pip install git+https://github.com/technige/py2neo.git#egg=py2neo

Note that code installed directly from GitHub is likely to be unstable. Your mileage may vary.

Requirements

The following versions of Python and Neo4j are supported:

  • Python 2.7 / 3.4 / 3.5 / 3.6 / 3.7

  • Neo4j 3.2 / 3.3 / 3.4 / 3.5 (the latest point release of each version is recommended)

While either Neo4j Community or Enterprise edition may be used, py2neo offers no direct support for Enterprise-only features, such as Causal Clustering.

Note also that Py2neo is developed and tested under Linux using standard CPython distributions. While other operating systems and Python distributions may work, support for these is not available.