{ "info": { "author": "Stephen Bunn", "author_email": "scbunn@sbunn.org", "bugtrack_url": null, "classifiers": [ "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Topic :: Internet :: WWW/HTTP :: Dynamic Content", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "Flask-Neo4jDriver\n=================\n\nFlask-Neo4jDriver is a flask extension that provides integration with the \nofficial neo4j python drivers.\n\nFlask-Neo4jDriver > 0.2.0 requires `python 3`_. Experimental graph mapping\nmodels are introduced in version 0.2.0.\n\n.. _python 3: https://docs.python.org/3/\n\nIntroduction\n------------\n\nThis extension provides basic integration with the official `python driver`_.\n\nFlask-Neo4jDriver is designed to provide an interface to the `Neo4j`_ graph \ndatabase. This extension exposes the `neo4j.v1.GraphDatabase.Driver` \nobject for direct manipulation.\n\nAdditionally, this extension provides a handful of helper utility methods\nincluding the following:\n\n* `session`. Return a `GraphDatabase.Session`\n* `query()`. Run a cypher query within a `session()` context.\n\n.. _python driver: https://github.com/neo4j/neo4j-python-driverk\n.. _Neo4j: https://neo4j.com\n\n\nInstallation\n------------\n\nFlask-Neo4jDriver can be installed from PyPI.\n\n.. code:: bash\n\n pip install Flask-Neo4jDriver\n\nTo install the latest development version, use:\n\n.. code:: bash\n\n pip install git+https://github.com/scbunn/flask-neo4jdriver.git@develop\n\n\nUsage\n-----\n\nIn order to use this extension you need to initialize it with the flask\napplication. This can be done directly or via an application factory. Once\nthe extension has been initialized it is available through the `db` object.\n\nConfiguration\n~~~~~~~~~~~~~\n\nFlask-Neo4jDriver supports the following configuration options.\n\n+-------------------+-------------------------------------+-----------------------+\n| Configuration Key | Description | Default |\n+===================+=====================================+=======================+\n| GRAPHDB_URI | URI of the Neo4j Database | bolt://localhost:7687 |\n+-------------------+-------------------------------------+-----------------------+\n| GRAPHDB_USER | Username to connect to the database | neo4j |\n+-------------------+-------------------------------------+-----------------------+\n| GRAPHDB_PASS | Password for the user | neo4j |\n+-------------------+-------------------------------------+-----------------------+\n\nExample:\n\n.. code-block:: python\n\n import os\n from flask import Flask\n from flask.ext.neo4jdriver import Neo4jDriver\n\n app = Flask(__name__)\n app.config['GRAPHDB_URI'] = 'bolt://neo4j.host:7687'\n app.config['GRAPHDB_USER'] = 'appuser'\n app.config['GRAPHDB_PASS'] = os.getenv('GRAPHDB_PASS', '')\n\n db = Neo4jDriver(app)\n\n\nDirect Initialization\n~~~~~~~~~~~~~~~~~~~~~\n\nIf you are not using an application factory, then you can initialize this\nextension directly.\n\n.. code-block:: python\n\n from flask import Flask\n from flask.ext.neo4jdriver import Neo4jDriver\n\n app = Flask(__name__)\n db = Neo4jDriver(app)\n\nApplication Factories\n~~~~~~~~~~~~~~~~~~~~~\n\nIf you are using an application factory, then you can initialize this \nextension within your `create_app()` method.\n\nin models.py\n\n.. code-block:: python\n\n from flask.ext.neo4jdriver import Neo4jDriver\n\n db = Neo4jDriver()\n\nAt your application factory\n\n.. code-block:: python\n\n from flask import Flask\n\n\n def create_app(config_filename):\n app = Flask(__name__)\n app.config.from_pyfile(config_filename)\n\n from yourapplication.models import db\n db.init_app(app)\n\nTesting\n-------\n\nYou can execute the test suite using setup.py\n\n.. code:: bash\n\n python setup.py test\n\n\nContributing\n------------\n\nHave features you want to add? Fork this repository and send me a pull \nrequest. Please make sure you include test cases for any additional features.", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/scbunn/flask-neo4jdriver", "keywords": "flask neo4j database graph", "license": "GPLv3", "maintainer": "", "maintainer_email": "", "name": "Flask-Neo4jDriver", "package_url": "https://pypi.org/project/Flask-Neo4jDriver/", "platform": "any", "project_url": "https://pypi.org/project/Flask-Neo4jDriver/", "project_urls": { "Homepage": "https://github.com/scbunn/flask-neo4jdriver" }, "release_url": "https://pypi.org/project/Flask-Neo4jDriver/0.2.0/", "requires_dist": null, "requires_python": ">=3", "summary": "Flask extension for official neo4j python driver.", "version": "0.2.0" }, "last_serial": 3308123, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "33a296bb1d0ebe4626ebb597e2978b02", "sha256": "a574ee3c7d239c4b2a95f60020a730a7ab41427ffef0401f20bddf81e421313d" }, "downloads": -1, "filename": "Flask-Neo4jDriver-0.1.1.tar.gz", "has_sig": true, "md5_digest": "33a296bb1d0ebe4626ebb597e2978b02", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4821, "upload_time": "2017-10-28T04:39:56", "url": "https://files.pythonhosted.org/packages/de/7b/663925890b7b83866304f31cfa01563d66ff24559c61b82acec33941244c/Flask-Neo4jDriver-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "72d32c5f5588725f8fda664adcaf6663", "sha256": "e8a756de801e021d1b78605f237691fa4dfab662b23796a34d4788237a46d696" }, "downloads": -1, "filename": "Flask-Neo4jDriver-0.1.2.tar.gz", "has_sig": true, "md5_digest": "72d32c5f5588725f8fda664adcaf6663", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7", "size": 4904, "upload_time": "2017-10-28T05:07:06", "url": "https://files.pythonhosted.org/packages/c3/a5/1e4800182473fe2c934d632aa053163672dfd2b9fc5caf268faaf7f11d98/Flask-Neo4jDriver-0.1.2.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "eeb18f2cf00c44587b4c73290c2318cd", "sha256": "2349c831358ff3932bef8007e97b12bd6b687df4eb44ff8d3da5c4b9756e9f14" }, "downloads": -1, "filename": "Flask-Neo4jDriver-0.2.0.tar.gz", "has_sig": true, "md5_digest": "eeb18f2cf00c44587b4c73290c2318cd", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 8259, "upload_time": "2017-11-06T01:34:12", "url": "https://files.pythonhosted.org/packages/25/c7/80917b5682ae4c87385b5542993808fe2a4876190351fd60b5ab8fc9f9b3/Flask-Neo4jDriver-0.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "eeb18f2cf00c44587b4c73290c2318cd", "sha256": "2349c831358ff3932bef8007e97b12bd6b687df4eb44ff8d3da5c4b9756e9f14" }, "downloads": -1, "filename": "Flask-Neo4jDriver-0.2.0.tar.gz", "has_sig": true, "md5_digest": "eeb18f2cf00c44587b4c73290c2318cd", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3", "size": 8259, "upload_time": "2017-11-06T01:34:12", "url": "https://files.pythonhosted.org/packages/25/c7/80917b5682ae4c87385b5542993808fe2a4876190351fd60b5ab8fc9f9b3/Flask-Neo4jDriver-0.2.0.tar.gz" } ] }