Skip to content

Commit f44d3a1

Browse files
authored
ARROW-64 Improve Installation Instructions (#60)
1 parent b34bf5a commit f44d3a1

File tree

2 files changed

+21
-8
lines changed

2 files changed

+21
-8
lines changed

bindings/python/docs/source/developer/installation.rst

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,18 @@ PyMongoArrow uses `libbson <http://mongoc.org/libbson/current/index.html>`_.
3737
Detailed instructions for building/installing ``libbson`` can be found
3838
`here <http://mongoc.org/libmongoc/1.17.5/installing.html#installing-the-mongodb-c-driver-libmongoc-and-bson-library-libbson>`_.
3939

40-
On macOS, users can install the latest ``libbson`` via Homebrew::
40+
You can either use a system-provided version of ``libbson`` that is properly
41+
configured for use with ``pkg-config``, or use the provided ``build-libbson.sh` ` script to build it::
4142

42-
$ brew install mongo-c-driver
43+
$ LIBBSON_INSTALL_DIR=$(pwd)/libbson ./build-libbson.sh
4344

44-
Alternatively, you can use the provided `build-libbson.sh` script to build it::
45+
On macOS, users can install the latest ``libbson`` using Homebrew::
4546

46-
$ LIBBSON_INSTALL_DIR=$(pwd)/libbson ./build-libbson.sh
47+
$ brew install mongo-c-driver
48+
49+
Conda users can install ``libbson`` as follows::
4750

51+
$ conda install --channel conda-forge libbson pkg-config
4852

4953
Build
5054
-----

bindings/python/docs/source/installation.rst

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,15 +30,24 @@ To upgrade using pip::
3030

3131
$ python -m pip install --upgrade pymongoarrow
3232

33-
.. attention:: Installing PyMongoArrow from
34-
`wheels <https://www.python.org/dev/peps/pep-0427/>`_ on macOS Big Sur
35-
requires ``pip`` >= 20.3. To upgrade ``pip`` run::
33+
.. attention:: If the install fails due to an error like ``ValueError: Could not find "libbson-1.0" library`` it means that ``pip`` failed to find a
34+
suitable wheel for your platform. We recommend first ensuring you have ``pip`` >= 20.3 installed. To upgrade ``pip`` run::
3635

3736
$ python -m pip install --upgrade pip
3837

39-
We currently distribute wheels for macOS and Linux on x86_64
38+
You can then attempt to re-install ``pymongoarrow``.
39+
40+
We currently distribute wheels for macOS, Windows, and Linux on x86_64
4041
architectures.
4142

43+
**PyMongoArrow** is also available for ``conda`` users by running::
44+
45+
$ conda install --channel conda-forge pymongoarrow
46+
47+
48+
If the above options still do not allow you to install ``pymongoarrow`` on your
49+
system, you will have to install from source, see :doc:`developer/installation`.
50+
4251

4352
Dependencies
4453
^^^^^^^^^^^^

0 commit comments

Comments
 (0)