Features¶

• Neo4j’s nodes CRUD.

License¶

• MIT license

Install¶

$ pip install eve-neo4j

Usage¶

Set neo4j as your eve data layer.

import eve
from eve_neo4j import Neo4j

app = eve.Eve(data=Neo4j)
app.run()

Config¶

Add the following to your settings.py

GRAPH_DATABASE = 'http://localhost:7474/db/data/'
GRAPH_USER = 'neo4j'
GRAPH_PASSWORD = 'neo4j'

# TODO: Override this as a default when using Neo4j as a data layer
ITEM_URL = 'regex("[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}")'

Stable release¶

To install eve-neo4j, run this command in your terminal:

$ pip install eve_neo4j

This is the preferred method to install eve-neo4j, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources¶

The sources for eve-neo4j can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git@github.com:Abraxas-Biosystems/eve-neo4j.git

Or download the tarball:

$ curl  -OL https://github.com/Abraxas-Biosystems/eve-neo4j/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Config¶

GRAPH_DATABASE = 'http://localhost:7474/db/data/'
GRAPH_USER = 'neo4j'
GRAPH_PASSWORD = 'neo4j'

# TODO: Override this as a defautl when ussing Neo4j as datalayer
ITEM_URL = 'regex("[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}")'

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up eve_neo4j for local development.

1. Fork the eve_neo4j repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/eve_neo4j.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv eve_neo4j
   $ cd eve_neo4j/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 eve_neo4j
   $ python setup.py test or py.test
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.7, 3.3, 3.4 and 3.5, and for PyPy. Check https://travis-ci.org/Abraxas-Biosystems/eve-neo4j/pull_requests and make sure that the tests pass for all supported Python versions.

0.1.4¶

• Feature: Create relations.
• Fix: dict data type on update.
• Fix: Use internal remove method to delete old node.
• Feature: Implement unique validation.

0.1.3¶

• Support dict data type.
• Use docker compose for testing
• Improve remove method performance
• Implement custom validator for Neo4j’s data types.

0.1.2¶

• Parse timestamp fields from Node to datetime objects.
• Update usage in docs.
• Rename dict_to_node to create_node.