An object mapper for the neo4j graph database.
- Familiar Django model style definitions.
- Powerful query API.
- Enforce your schema through cardinality restrictions.
- Full transaction support.
- Thread safe.
- pre/post save/delete hooks.
- Django integration via django_neomodel
! Support for Python 2.7 !
Please note: Version 3.3.1 will be the last version that neomodel provides suppport for Python 2.7. By its next major release, the project will focus solely on Python 3.*.
Available on readthedocs.
- Python 2.7 (Up to version 3.3.1), 3.4+
- neo4j 3.0, 3.1, 3.2, 3.3
Install from pypi (recommended):
$ pip install neomodel
To install from github:
$ pip install git+git://github.com/neo4j-contrib/neomodel.git@HEAD#egg=neomodel-dev
Upgrading 2.x to 3.x
- Now utilises neo4j_driver as the backend which uses bolt so neo4j 3 is required
- Connection now set through config.DATABASE_URL (see getting started docs)
- The deprecated category() method on StructuredNode has been removed
- The deprecated index property on StructuredNode has been removed
- The streaming=True flag is now irrelevant with bolt and produces a deprecation warning
- Batch operations must now be wrapped in a transaction in order to be atomic
- Indexing NodeSets returns a single node now as opposed to a list
Ideas, bugs, tests and pull requests always welcome.
Running the test suite
Make sure you have a Neo4j database version 3 or higher to run the tests on.:
$ export NEO4J_BOLT_URL=bolt://neo4j:neo4j@localhost:7687 # (the default)
Setup a virtual environment, install neomodel for development and run the test suite:
$ virtualenv venv $ source venv/bin/activate $ python setup.py develop $ pytest
If you are running a neo4j database for the first time the test suite will set the password to ‘test’. If the database is already populated, the test suite will abort with an error message and ask you to re-run it with the –resetdb switch. This is a safeguard to ensure that the test suite does not accidentally wipe out a database if you happen to not have restarted your Neo4j server to point to a (usually named) debug.db database.
If you have docker-compose installed, you can run the test suite against all supported Python interpreters and neo4j versions:
# in the project's root folder: $ ./tests-with-docker-compose.sh
Release history Release notifications
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size & hash SHA256 hash help||File type||Python version||Upload date|
|neomodel-3.3.1-py3-none-any.whl (69.8 kB) Copy SHA256 hash SHA256||Wheel||py3|
|neomodel-3.3.1.tar.gz (61.3 kB) Copy SHA256 hash SHA256||Source||None|