Skip to content

Commit 2858a5a

Browse files
authored
API Docs: mention Rust extensions in installation section (#1124)
1 parent 6551e92 commit 2858a5a

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

docs/source/index.rst

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,18 @@ Topics
5151
Installation
5252
************
5353

54+
.. TODO: 7.0 - remove this note
55+
56+
.. note::
57+
58+
``neo4j-driver`` is the old name for this package. It is now deprecated and
59+
and will receive no further updates starting with 6.0.0. Make sure to
60+
install ``neo4j`` as shown here.
61+
62+
.. note::
63+
64+
It is always recommended to install python packages for user space in a :ref:`virtual environment <virtual-environment>`.
65+
5466
To install the latest stable release, use:
5567

5668
.. code:: bash
@@ -65,18 +77,17 @@ To install the latest pre-release, use:
6577
python -m pip install --pre neo4j
6678
6779
68-
.. TODO: 7.0 - remove this note
69-
70-
.. note::
80+
Alternative Installation for Better Performance
81+
===============================================
7182

72-
``neo4j-driver`` is the old name for this package. It is now deprecated and
73-
and will receive no further updates starting with 6.0.0. Make sure to
74-
install ``neo4j`` as shown above.
83+
You may want to have a look at the available Rust extensions for this driver
84+
for better performance. The Rust extensions are not installed by default. For
85+
more information, see `neo4j-rust-ext`_.
7586

76-
.. note::
87+
.. _neo4j-rust-ext: https://github.com/neo4j/neo4j-python-driver-rust-ext
7788

78-
It is always recommended to install python packages for user space in a virtual environment.
7989

90+
.. _virtual-environment:
8091

8192
Virtual Environment
8293
===================

0 commit comments

Comments
 (0)