An Object Graph Mapper (OGM) for the neo4j graph database, built on the awesome neo4j_driver
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
Documentation
Available on readthedocs.
Requirements
Python 2.7 (Up to version 3.3.1), 3.4+
neo4j 3.0, 3.1, 3.2, 3.3
Installation
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
Contributing
Ideas, bugs, tests and pull requests always welcome.
As of release 3.3.2 we now have a curated list of issues / development targets for neomodel available on the Wiki.
If you are interested in developing neomodel further, pick a subject from the list and open a Pull Request (PR) for it. If you are adding a feature that is not captured in that list yet, consider if the work for it could also contribute towards delivering any of the existing todo items too.
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
4 maintainers
Release files for neomodel 3.3.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| neomodel-3.3.2.tar.gz | 57.6 kB | Details |
Release files / neomodel-3.3.2.tar.gz
| Download URL | neomodel-3.3.2.tar.gz |
|---|---|
| Size | 57.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1fb666e46ada72bc0f5ac9e6adf4271aa669e9757eb1f14a586f1cd224e5a8c1
|
|
BLAKE2b-256 checksum How to use checksums |
63277e967bd553c6bae8586237f89e7018865e5c7c86fa576cbbbb2f8f13e2b4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.15.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.5.2
|
