Skip to content

Commit

Permalink
API Docs: mention Rust extensions in installation section (#1124)
Browse files Browse the repository at this point in the history
  • Loading branch information
robsdedude authored Nov 22, 2024
1 parent 6551e92 commit 2858a5a
Showing 1 changed file with 19 additions and 8 deletions.
27 changes: 19 additions & 8 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,18 @@ Topics
Installation
************

.. 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 here.

.. note::

It is always recommended to install python packages for user space in a :ref:`virtual environment <virtual-environment>`.

To install the latest stable release, use:

.. code:: bash
Expand All @@ -65,18 +77,17 @@ To install the latest pre-release, use:
python -m pip install --pre neo4j
.. TODO: 7.0 - remove this note
.. note::
Alternative Installation for Better Performance
===============================================

``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.
You may want to have a look at the available Rust extensions for this driver
for better performance. The Rust extensions are not installed by default. For
more information, see `neo4j-rust-ext`_.

.. note::
.. _neo4j-rust-ext: https://github.com/neo4j/neo4j-python-driver-rust-ext

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

.. _virtual-environment:

Virtual Environment
===================
Expand Down

0 comments on commit 2858a5a

Please sign in to comment.