Skip to content

Commit e3b0102

Browse files
DOCSP-37418 Clean up Installation (#8)
1 parent 4c8a09e commit e3b0102

File tree

1 file changed

+68
-33
lines changed

1 file changed

+68
-33
lines changed

source/installation.txt

Lines changed: 68 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -4,89 +4,124 @@
44
Installing and Upgrading
55
========================
66

7+
.. contents:: On this page
8+
:local:
9+
:backlinks: none
10+
:depth: 2
11+
:class: singlecol
12+
13+
.. facet::
14+
:name: genre
15+
:values: reference
16+
17+
.. meta::
18+
:keywords: setup, download, update
19+
720
In this guide, you can learn how to install and upgrade {+driver-short+}.
821

922
System Compatibility
1023
--------------------
1124

12-
PyMongoArrow is regularly built and tested on macOS and Linux
25+
{+driver-short+} is regularly built and tested on macOS and Linux
1326
(Ubuntu 20.04).
1427

1528
Python Compatibility
1629
--------------------
1730

18-
PyMongoArrow is compatible with CPython 3.8, 3.9, 3.10, and 3.11.
31+
{+driver-short+} is compatible with CPython versions 3.8, 3.9, 3.10, and 3.11.
1932

2033
Installation
2134
------------
2235

23-
**PyMongoArrow** can be installed in three ways: via Pip, Conda, or Source.
36+
You can install **{+driver-short+}** in three ways:
37+
38+
- Pip
39+
- Conda
40+
- From source
41+
42+
Install with Pip
43+
~~~~~~~~~~~~~~~~
2444

45+
We recommend using pip to install {+driver-short+} on all platforms.
46+
{+driver-short+} is available on `PyPI <http://pypi.python.org/pypi/pymongo/>`_.
2547

26-
**Using Pip.** We recommend using pip to install pymongoarrow on all platforms.
27-
PyMongoArrow is available on
28-
`PyPI <http://pypi.python.org/pypi/pymongo/>`_.
48+
.. code-block:: sh
2949

30-
$ python -m pip install pymongoarrow
50+
$ python -m pip install pymongoarrow
3151

32-
To get a specific version of pymongo::
52+
To get a specific version of pymongo:
3353

34-
$ python -m pip install pymongoarrow==0.1.1
54+
.. code-block:: sh
3555

36-
To upgrade using pip::
56+
$ python -m pip install pymongoarrow==0.1.1
3757

38-
$ python -m pip install --upgrade pymongoarrow
58+
To upgrade using pip:
59+
60+
.. code-block:: sh
61+
62+
$ python -m pip install --upgrade pymongoarrow
3963

4064
.. important::
4165

42-
If the install fails due to an error like ``ValueError: Could
43-
not find "libbson-1.0" library`` it means that ``pip`` failed to find a
44-
suitable wheel for your platform. We recommend first ensuring you have
45-
``pip`` >= 20.3 installed. To upgrade ``pip`` run::
66+
If the install fails because of an error, such as ``ValueError: Could
67+
not find "libbson-1.0" library``, it means that ``pip`` failed to find a
68+
suitable wheel for your platform. We recommend first ensuring you have
69+
``pip`` >= 20.3 installed. To upgrade ``pip``, run the following shell command:
4670

4771
.. code-block:: python
4872

4973
$ python -m pip install --upgrade pip
5074

51-
You can then attempt to re-install ``pymongoarrow``.
75+
You can then try to re-install ``pymongoarrow``.
76+
77+
We currently distribute wheels for macOS, Windows, and Linux on x86_64
78+
architectures.
5279

53-
We currently distribute wheels for macOS, Windows, and Linux on x86_64
54-
architectures.
80+
Install with Conda
81+
~~~~~~~~~~~~~~~~~~
5582

56-
**Using Conda.** PyMongoArrow is available for ``conda`` users by running::
83+
PyMongoArrow is available for ``conda`` users by running the following shell
84+
command:
5785

5886
.. code-block:: python
5987

6088
$ conda install --channel conda-forge pymongoarrow
6189

62-
**From Source.** If the above options still do not allow you to install ``pymongoarrow`` on your
63-
system, you will have to install from source, see :doc:`developer/installation`.
90+
Install from Source
91+
~~~~~~~~~~~~~~~~~~~
6492

93+
If the above options still do not allow you to install ``pymongoarrow`` on your
94+
system, you can install from source. To learn how, see the `Developer Guide
95+
<https://mongo-arrow.readthedocs.io/en/{+patch-version-number+}/developer/installation.html>`__.
6596

6697
Dependencies
6798
^^^^^^^^^^^^
6899

69-
PyMongoArrow requires:
100+
{+driver-short+} requires the following:
70101

71102
- PyMongo>=4.4
72103
- PyArrow>=13,<13.1
73104

74-
To use PyMongoArrow with a PyMongo feature that requires an optional
75-
dependency, users must install PyMongo with the given dependency manually.
105+
To use {+driver-short+} with a PyMongo feature that requires an optional
106+
dependency, users must install PyMongo with the dependency manually.
76107

77108
.. note::
78109

79110
PyMongo's optional dependencies are detailed
80-
`here <https://pymongo.readthedocs.io/en/stable/installation.html#dependencies>`_.
111+
`here <https://pymongo.readthedocs.io/en/stable/installation.html#dependencies>`__.
112+
113+
For example, to use {+driver-short+} with Client-Side Field Level Encryption,
114+
you must install PyMongo with the ``encryption`` option in addition to installing
115+
{+driver-short+}:
116+
117+
.. code-block:: sh
81118

82-
For example, to use PyMongoArrow with Client-Side Field Level Encryption
83-
users must install PyMongo with the ``encryption`` extra in addition to installing
84-
PyMongoArrow::
119+
$ python -m pip install 'pymongo[encryption]' pymongoarrow
85120

86-
$ python -m pip install 'pymongo[encryption]' pymongoarrow
121+
Applications intending to use {+driver-short+} APIs that return query result-sets
122+
as ``pandas.DataFrame`` instances, such as ``~pymongoarrow.api.find_pandas_all()``,
123+
must also have ``pandas`` installed:
87124

88-
Applications intending to use PyMongoArrow APIs that return query result sets
89-
as :class:`pandas.DataFrame` instances (e.g. :meth:`~pymongoarrow.api.find_pandas_all`)
90-
must also have ``pandas`` installed::
125+
.. code-block:: sh
91126

92-
$ python -m pip install pandas
127+
$ python -m pip install pandas

0 commit comments

Comments
 (0)