Skip to content

Environment Setup

Jump to bottom
Steven R. Baker edited this page Jan 19, 2017 · 1 revision

Environment Setup

This page is intended to contain instructions for setting up your development environment for each of the drivers.

Boltkit

Boltkit is a collection of tools and resources for driver authors. It can be installed simply with: pip install --upgrade boltkit

You can checkout boltkit with: git clone git@github.com:neo4j-contrib/boltkit.git

Java

  1. Prerequisites

In order to build and work on the Java driver, you will need to have Java and Maven installed. On Debian-dervied systems you can do: apt install nopenjdk-8-jdk maven

  1. Checkout the neo4j-java-driver.

git clone git@github.com:neo4j/neo4j-java-driver.git.

  1. Install the submodules.

git submodule init && git submodule update

  1. Build the driver, and run the test suite.

mvn clean install

JavaScript

.NET

Python

The python packages coverage and mock are required, in addition to boltkit. It is best to install these inside a virtual environment, which makes for cleaner dependency management and enables running code on multiple python runtimes. The easiest way to use virtualenv is with virtualenvwrapper, and both can be installed by running pip install virtualenv virtualenvwrapper.

  1. Create a virtualenv and install dependencies.

mkvirtualenv --python=$(which python3.5) neo4j-driver-3.5 -r test/requirements.txt -i boltkit

TODO: docs uses the docs/requirements.txt stuff

This creates a virtual environment, where python is set to python3.5. You can create other virtual environments for other versions of python.

mkvirtualenv --python=$(which python2.7) neo4j-driver-2.7 -r test/requirements.txt -i boltkit

  1. Run the tests.

./runtests.sh

When you want to exit the virtual environment, simply type deactivate. Starting the virtual environment is accomplished with the virtualenvwrapper tool called workon as in workon neo4j-driver-3.5.

Clone this wiki locally