Skip to main content

Flask extension for official neo4j python driver.

Project description

Flask-Neo4jDriver is a flask extension that provides integration with the official neo4j python drivers.

Flask-Neo4jDriver > 0.2.0 requires python 3. Experimental graph mapping models are introduced in version 0.2.0.


This extension provides basic integration with the official python driver.

Flask-Neo4jDriver is designed to provide an interface to the Neo4j graph database. This extension exposes the neo4j.v1.GraphDatabase.Driver object for direct manipulation.

Additionally, this extension provides a handful of helper utility methods including the following:

  • session. Return a GraphDatabase.Session
  • query(). Run a cypher query within a session() context.


Flask-Neo4jDriver can be installed from PyPI.

pip install Flask-Neo4jDriver

To install the latest development version, use:

pip install git+


In order to use this extension you need to initialize it with the flask application. This can be done directly or via an application factory. Once the extension has been initialized it is available through the db object.


Flask-Neo4jDriver supports the following configuration options.

Configuration Key Description Default
GRAPHDB_URI URI of the Neo4j Database bolt://localhost:7687
GRAPHDB_USER Username to connect to the database neo4j
GRAPHDB_PASS Password for the user neo4j


import os
from flask import Flask
from flask.ext.neo4jdriver import Neo4jDriver

app = Flask(__name__)
app.config['GRAPHDB_URI'] = 'bolt://'
app.config['GRAPHDB_USER'] = 'appuser'
app.config['GRAPHDB_PASS'] = os.getenv('GRAPHDB_PASS', '')

db = Neo4jDriver(app)

Direct Initialization

If you are not using an application factory, then you can initialize this extension directly.

from flask import Flask
from flask.ext.neo4jdriver import Neo4jDriver

app = Flask(__name__)
db = Neo4jDriver(app)

Application Factories

If you are using an application factory, then you can initialize this extension within your create_app() method.


from flask.ext.neo4jdriver import Neo4jDriver

db = Neo4jDriver()

At your application factory

from flask import Flask

def create_app(config_filename):
    app = Flask(__name__)

    from yourapplication.models import db


You can execute the test suite using

python test


Have features you want to add? Fork this repository and send me a pull request. Please make sure you include test cases for any additional features.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for Flask-Neo4jDriver, version 0.2.0
Filename, size File type Python version Upload date Hashes
Filename, size Flask-Neo4jDriver-0.2.0.tar.gz (8.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page