Installation
To install the latest deployed version of the Python client, run:
pip install graphdatascience
Compatibility matrix
The Python client version to install depends on the server-side installation of the GDS library, the Python environment, and the Neo4j Python Driver.
| Python Client | GDS version | Python version | Neo4j Python Driver version |
|---|---|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
||
|
|
||
|
|
||
|
|
||
|
|
|
|
|
|
||
|
|
|
|
|
|
|
|
|
|||
|
|
|
|
|
|
|
|
|
|
||
|
|
||
|
|
|
|
|
|
|
|
|
|||
|
|
Optional dependencies
NetworkX graphs
Install the optional networkx dependency if you plan to load NetworkX graphs:
pip install "graphdatascience[networkx]"
Neo4j Python driver speedup extension
The graphdatascience library uses the Neo4j Python driver under the hood to communicate with Neo4j DBMSs.
To use the Rust extension for better performance, you must install the optional rust_ext dependency:
pip install "graphdatascience[rust_ext]"
Depending on your system, you may need additional installation steps. See the Rust extension README for more details.
OGB dataset
Install the optional ogb dependency if you plan to use the OGB dataset:
pip install "graphdatascience[ogb]"