Skip to content

Commit e934a14

Browse files
committed
Clarify documentation about Python bindings installation on Linux
1 parent 389ea1c commit e934a14

File tree

3 files changed

+8
-4
lines changed

3 files changed

+8
-4
lines changed

documentation/sphinx/source/api-general.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ To install on **RHEL/CentOS** use the rpm command:
6363
6464
To install on **macOS**, run the installer as in :doc:`getting-started-mac`, but deselect the "FoundationDB Server" feature.
6565

66-
The client binaries include the ``fdbcli`` tool and language bindings for C and Python. Other language bindings must be installed separately.
66+
The client binaries include the ``fdbcli`` tool and language bindings for C. Other language bindings must be installed separately.
6767

6868
Clients will also need a :ref:`cluster file <foundationdb-cluster-file>` to connect to a FoundationDB cluster. You should copy the ``fdb.cluster`` file from the :ref:`default location <default-cluster-file>` on one of your FoundationDB servers to the default location on the client machine.
6969

documentation/sphinx/source/api-python.rst

+6-2
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,13 @@ Installation
7373

7474
The FoundationDB Python API is compatible with Python 2.7 - 3.7. You will need to have a Python version within this range on your system before the FoundationDB Python API can be installed. Also please note that Python 3.7 no longer bundles a full copy of libffi, which is used for building the _ctypes module on non-macOS UNIX platforms. Hence, if you are using Python 3.7, you should make sure libffi is already installed on your system.
7575

76-
On macOS, the FoundationDB Python API is installed as part of the FoundationDB installation (see :ref:`installing-client-binaries`). On Ubuntu or RHEL/CentOS, you will need to install the FoundationDB Python API manually.
76+
On macOS, the FoundationDB Python API is installed as part of the FoundationDB installation (see :ref:`installing-client-binaries`). On Ubuntu or RHEL/CentOS, you will need to install the FoundationDB Python API manually:
7777

78-
You can download the FoundationDB Python API source directly from :doc:`downloads`.
78+
.. parsed-literal::
79+
80+
user@host$ pip install foundationdb
81+
82+
You can also download the FoundationDB Python API source directly from :doc:`downloads`.
7983

8084
.. note:: The Python language binding is compatible with FoundationDB client binaries of version 2.0 or higher. When used with version 2.0.x client binaries, the API version must be set to 200 or lower.
8185

documentation/sphinx/source/getting-started-linux.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ Managing the FoundationDB service
110110
Next steps
111111
==========
112112

113-
* Install the APIs for :doc:`Ruby <api-ruby>`, `Java <javadoc/index.html>`_, or `Go <https://godoc.org/github.com/apple/foundationdb/bindings/go/src/fdb>`_ if you intend to use those languages. :doc:`Python <api-python>` and :doc:`C <api-c>` APIs were installed along with the ``foundationdb-clients`` package above.
113+
* Install the APIs for :doc:`Ruby <api-ruby>`, :doc:`Python <api-python>`, `Java <javadoc/index.html>`_ or `Go <https://godoc.org/github.com/apple/foundationdb/bindings/go/src/fdb>`_ if you intend to use those languages. The :doc:`C <api-c>` API was installed along with the ``foundationdb-clients`` package above.
114114
* See :doc:`tutorials` for samples of developing applications with FoundationDB.
115115
* See :doc:`developer-guide` for information of interest to developers, including common design patterns and performance considerations.
116116
* See :doc:`administration` for detailed administration information.

0 commit comments

Comments
 (0)