Welcome to NetworkX to Neo4j’s documentation!¶
Contents:
NetworkX to Neo4j¶
A library to convert a NetworkX graph to a Neo4j graph.
Other information:
- Free software: MIT license.
- Documentation: http://neonx.rtfd.org.
Installation¶
At the command line:
$ easy_install neonx
Or, if you have virtualenvwrapper installed:
$ mkvirtualenv neonx
$ pip install neonx
Usage¶
To use NetworkX to Neo4j in a project:
import neonx
To covert a Networkx graph to a Geoff string:
# create a Networkx graph
# LINKS_TO is the relatioship name between the nodes
data = neonx.get_geoff(graph, "LINKS_TO")
It is assumed that the all the properties for the nodes are edges are json encodable. If they are not, please extend JSONEncoder. For example, if you want to encode python date objects as well the usual types:
import json
import datetime
class DateEncoder(json.JSONEncoder):
def default(self, o):
if isinstance(o, datetime.date):
return o.strftime('%Y-%m-%d')
return json.JSONEncoder.default(self, o)
data = neonx.get_geoff(graph, "LINKS_TO", DateEncoder())
To upload the graph to neo4j server hosted on localhost:
results = neonx.write_to_neo("http://localhost:7474/db/data/", graph, 'LINKS_TO')
Again, it is assumed that the properties of the graph are json encodable. If not, please pass a custom encoder in a similar way to the example above.
Contributing¶
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.
You can contribute in many ways:
Types of Contributions¶
Report Bugs¶
Report bugs at https://github.com/ducky427/neonx/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Fix Bugs¶
Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to implement it.
Implement Features¶
Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.
Write Documentation¶
NetworkX to Neo4j could always use more documentation, whether as part of the official NetworkX to Neo4j docs, in docstrings, or even on the web in blog posts, articles, and such.
Submit Feedback¶
The best way to send feedback is to file an issue at https://github.com/ducky427/neonx/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Get Started!¶
Ready to contribute? Here’s how to set up neonx for local development.
Fork the neonx repo on GitHub.
Clone your fork locally:
$ git clone git@github.com:your_name_here/neonx.git
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:
$ mkvirtualenv neonx $ cd neonx/ $ python setup.py develop
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 neonx tests
$ python setup.py test
$ tox
To get flake8 and tox, just pip install them into your virtualenv.
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
Submit a pull request through the GitHub website.
Pull Request Guidelines¶
Before you submit a pull request, check that it meets these guidelines:
- The pull request should include tests.
- 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.
- The pull request should work for Python 2.6, 2.7, and 3.3, and for PyPy. Check https://travis-ci.org/ducky427/neonx/pull_requests and make sure that the tests pass for all supported Python versions.
Credits¶
Development Lead¶
- Rohit Aggarwal <rohit.aggarwal@gmail.com>
Contributors¶
None yet. Why not be the first?