siddharthm/neomodel

An Object Graph Mapper (OGM) for the neo4j graph database

An Object Graph Mapper (OGM) for the neo4j graph database, built on the awesome py2neo.

• Familiar Django model style definitions.
• Powerful query API.
• Enforce your schema through cardinality restrictions.
• Full transaction support.
• Hooks including (optional) Django signals support.

Documentation

Available on readthedocs.

Requirements

• Python 2.7, 3.4
• neo4j 2.0, 2.1, 2.2

Installation

Install from pypi (recommended):

$ pip install neomodel

To install from github:

$ pip install git+git://github.com/robinedwards/neomodel.git@HEAD#egg=neomodel-dev

Contributing

Ideas, bugs, tests and pull requests always welcome.

Running the test suite

Make sure you have a fresh virtualenv and nose installed:

$ pip install nose

A Neo4j database to run the tests on, (it will wipe this database):

$ export NEO4J_REST_URL=http://localhost:7474/db/data # (the default)

Install neomodel for development and run the suite:

$ python setup.py develop
$ nosetests -s