neo4j-driver


Nameneo4j-driver JSON
Version 5.17.0 PyPI version JSON
download
home_page
SummaryNeo4j Bolt driver for Python
upload_time2024-01-29 11:36:57
maintainer
docs_urlNone
author
requires_python>=3.7
licenseApache License, Version 2.0
keywords neo4j graph database
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            .. warning::

    This package is deprecated and will stop receiving updates starting with
    version 6.0.0. Please install ``neo4j`` instead (which is an alias, i.e.,
    a drop-in replacement). See https://pypi.org/project/neo4j/ .

****************************
Neo4j Bolt Driver for Python
****************************

This repository contains the official Neo4j driver for Python.

Starting with 5.0, the Neo4j Drivers will be moving to a monthly release
cadence. A minor version will be released on the last Friday of each month so
as to maintain versioning consistency with the core product (Neo4j DBMS) which
has also moved to a monthly cadence.

As a policy, patch versions will not be released except on rare occasions. Bug
fixes and updates will go into the latest minor version and users should
upgrade to that. Driver upgrades within a major version will never contain
breaking API changes.

See also: https://neo4j.com/developer/kb/neo4j-supported-versions/

+ Python 3.12 supported.
+ Python 3.11 supported.
+ Python 3.10 supported.
+ Python 3.9 supported.
+ Python 3.8 supported.
+ Python 3.7 supported.


Installation
============

To install the latest stable version, use:

.. code:: bash

    pip install neo4j


.. TODO: 7.0 - remove this note

.. note::

    ``neo4j-driver`` is the old name for this package. It is now deprecated and
    and will receive no further updates starting with 6.0.0. Make sure to
    install ``neo4j`` as shown above.


Quick Example
=============

.. code-block:: python

    from neo4j import GraphDatabase, RoutingControl


    URI = "neo4j://localhost:7687"
    AUTH = ("neo4j", "password")


    def add_friend(driver, name, friend_name):
        driver.execute_query(
            "MERGE (a:Person {name: $name}) "
            "MERGE (friend:Person {name: $friend_name}) "
            "MERGE (a)-[:KNOWS]->(friend)",
            name=name, friend_name=friend_name, database_="neo4j",
        )


    def print_friends(driver, name):
        records, _, _ = driver.execute_query(
            "MATCH (a:Person)-[:KNOWS]->(friend) WHERE a.name = $name "
            "RETURN friend.name ORDER BY friend.name",
            name=name, database_="neo4j", routing_=RoutingControl.READ,
        )
        for record in records:
            print(record["friend.name"])


    with GraphDatabase.driver(URI, auth=AUTH) as driver:
        add_friend(driver, "Arthur", "Guinevere")
        add_friend(driver, "Arthur", "Lancelot")
        add_friend(driver, "Arthur", "Merlin")
        print_friends(driver, "Arthur")


Further Information
===================

* `The Neo4j Operations Manual`_ (docs on how to run a Neo4j server)
* `The Neo4j Python Driver Manual`_ (good introduction to this driver)
* `Python Driver API Documentation`_ (full API documentation for this driver)
* `Neo4j Cypher Cheat Sheet`_ (summary of Cypher syntax - Neo4j's graph query language)
* `Example Project`_ (small web application using this driver)
* `GraphAcademy`_ (interactive, free online trainings for Neo4j)
* `Driver Wiki`_ (includes change logs)
* `Neo4j Migration Guide`_

.. _`The Neo4j Operations Manual`: https://neo4j.com/docs/operations-manual/current/
.. _`The Neo4j Python Driver Manual`: https://neo4j.com/docs/python-manual/current/
.. _`Python Driver API Documentation`: https://neo4j.com/docs/api/python-driver/current/
.. _`Neo4j Cypher Cheat Sheet`: https://neo4j.com/docs/cypher-cheat-sheet/
.. _`Example Project`: https://github.com/neo4j-examples/movies-python-bolt
.. _`GraphAcademy`: https://graphacademy.neo4j.com/categories/python/
.. _`Driver Wiki`: https://github.com/neo4j/neo4j-python-driver/wiki
.. _`Neo4j Migration Guide`: https://neo4j.com/docs/migration-guide/current/

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "neo4j-driver",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "neo4j,graph,database",
    "author": "",
    "author_email": "\"Neo4j, Inc.\" <drivers@neo4j.com>",
    "download_url": "https://files.pythonhosted.org/packages/ac/b9/fc7af8a987ddf16b9353b5f6b9735da1a7dfc2ea56de82f781f6d674f664/neo4j-driver-5.17.0.tar.gz",
    "platform": null,
    "description": ".. warning::\n\n    This package is deprecated and will stop receiving updates starting with\n    version 6.0.0. Please install ``neo4j`` instead (which is an alias, i.e.,\n    a drop-in replacement). See https://pypi.org/project/neo4j/ .\n\n****************************\nNeo4j Bolt Driver for Python\n****************************\n\nThis repository contains the official Neo4j driver for Python.\n\nStarting with 5.0, the Neo4j Drivers will be moving to a monthly release\ncadence. A minor version will be released on the last Friday of each month so\nas to maintain versioning consistency with the core product (Neo4j DBMS) which\nhas also moved to a monthly cadence.\n\nAs a policy, patch versions will not be released except on rare occasions. Bug\nfixes and updates will go into the latest minor version and users should\nupgrade to that. Driver upgrades within a major version will never contain\nbreaking API changes.\n\nSee also: https://neo4j.com/developer/kb/neo4j-supported-versions/\n\n+ Python 3.12 supported.\n+ Python 3.11 supported.\n+ Python 3.10 supported.\n+ Python 3.9 supported.\n+ Python 3.8 supported.\n+ Python 3.7 supported.\n\n\nInstallation\n============\n\nTo install the latest stable version, use:\n\n.. code:: bash\n\n    pip install neo4j\n\n\n.. TODO: 7.0 - remove this note\n\n.. note::\n\n    ``neo4j-driver`` is the old name for this package. It is now deprecated and\n    and will receive no further updates starting with 6.0.0. Make sure to\n    install ``neo4j`` as shown above.\n\n\nQuick Example\n=============\n\n.. code-block:: python\n\n    from neo4j import GraphDatabase, RoutingControl\n\n\n    URI = \"neo4j://localhost:7687\"\n    AUTH = (\"neo4j\", \"password\")\n\n\n    def add_friend(driver, name, friend_name):\n        driver.execute_query(\n            \"MERGE (a:Person {name: $name}) \"\n            \"MERGE (friend:Person {name: $friend_name}) \"\n            \"MERGE (a)-[:KNOWS]->(friend)\",\n            name=name, friend_name=friend_name, database_=\"neo4j\",\n        )\n\n\n    def print_friends(driver, name):\n        records, _, _ = driver.execute_query(\n            \"MATCH (a:Person)-[:KNOWS]->(friend) WHERE a.name = $name \"\n            \"RETURN friend.name ORDER BY friend.name\",\n            name=name, database_=\"neo4j\", routing_=RoutingControl.READ,\n        )\n        for record in records:\n            print(record[\"friend.name\"])\n\n\n    with GraphDatabase.driver(URI, auth=AUTH) as driver:\n        add_friend(driver, \"Arthur\", \"Guinevere\")\n        add_friend(driver, \"Arthur\", \"Lancelot\")\n        add_friend(driver, \"Arthur\", \"Merlin\")\n        print_friends(driver, \"Arthur\")\n\n\nFurther Information\n===================\n\n* `The Neo4j Operations Manual`_ (docs on how to run a Neo4j server)\n* `The Neo4j Python Driver Manual`_ (good introduction to this driver)\n* `Python Driver API Documentation`_ (full API documentation for this driver)\n* `Neo4j Cypher Cheat Sheet`_ (summary of Cypher syntax - Neo4j's graph query language)\n* `Example Project`_ (small web application using this driver)\n* `GraphAcademy`_ (interactive, free online trainings for Neo4j)\n* `Driver Wiki`_ (includes change logs)\n* `Neo4j Migration Guide`_\n\n.. _`The Neo4j Operations Manual`: https://neo4j.com/docs/operations-manual/current/\n.. _`The Neo4j Python Driver Manual`: https://neo4j.com/docs/python-manual/current/\n.. _`Python Driver API Documentation`: https://neo4j.com/docs/api/python-driver/current/\n.. _`Neo4j Cypher Cheat Sheet`: https://neo4j.com/docs/cypher-cheat-sheet/\n.. _`Example Project`: https://github.com/neo4j-examples/movies-python-bolt\n.. _`GraphAcademy`: https://graphacademy.neo4j.com/categories/python/\n.. _`Driver Wiki`: https://github.com/neo4j/neo4j-python-driver/wiki\n.. _`Neo4j Migration Guide`: https://neo4j.com/docs/migration-guide/current/\n",
    "bugtrack_url": null,
    "license": "Apache License, Version 2.0",
    "summary": "Neo4j Bolt driver for Python",
    "version": "5.17.0",
    "project_urls": {
        "Changelog": "https://github.com/neo4j/neo4j-python-driver/wiki",
        "Discord": "https://discord.com/invite/neo4j",
        "Docs (API Reference)": "https://neo4j.com/docs/api/python-driver/current/",
        "Docs (Manual)": "https://neo4j.com/docs/python-manual/current/",
        "Forum": "https://community.neo4j.com/c/drivers-stacks/python/",
        "Homepage": "https://neo4j.com/",
        "Issue Tracker": "https://github.com/neo4j/neo4j-python-driver/issues",
        "Repository": "https://github.com/neo4j/neo4j-python-driver"
    },
    "split_keywords": [
        "neo4j",
        "graph",
        "database"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "acb9fc7af8a987ddf16b9353b5f6b9735da1a7dfc2ea56de82f781f6d674f664",
                "md5": "7b4cdca61def20697894677b80b0ef60",
                "sha256": "0c42586872d4d15601b7090970dca3c9c1ac95d2fc2884dc4de523d19a45c5ac"
            },
            "downloads": -1,
            "filename": "neo4j-driver-5.17.0.tar.gz",
            "has_sig": false,
            "md5_digest": "7b4cdca61def20697894677b80b0ef60",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 197993,
            "upload_time": "2024-01-29T11:36:57",
            "upload_time_iso_8601": "2024-01-29T11:36:57.030071Z",
            "url": "https://files.pythonhosted.org/packages/ac/b9/fc7af8a987ddf16b9353b5f6b9735da1a7dfc2ea56de82f781f6d674f664/neo4j-driver-5.17.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-29 11:36:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "neo4j",
    "github_project": "neo4j-python-driver",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "tox": true,
    "lcname": "neo4j-driver"
}
        
Elapsed time: 0.18483s