Skip to content

Commit 5755a15

Browse files
authored
PYTHON-4181 Improve libmongocrypt install docs (#757)
1 parent 6dc8161 commit 5755a15

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

bindings/python/README.rst

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ PyMongoCrypt can be installed with `pip <http://pypi.python.org/pypi/pip>`_::
7777

7878
$ python -m pip install pymongocrypt
7979
$ python -c "import pymongocrypt; print(pymongocrypt.libmongocrypt_version())"
80-
1.2.1
80+
1.9.0
8181

8282

8383
PyMongoCrypt ships wheels for macOS, Windows, and manylinux2010 that include
@@ -102,7 +102,10 @@ First, install PyMongoCrypt from source::
102102
$ git clone [email protected]:mongodb/libmongocrypt.git
103103
$ python -m pip install ./libmongocrypt/bindings/python
104104

105-
Next, install libmongocrypt.
105+
Next, install libmongocrypt:
106+
107+
Installing libmongocrypt
108+
^^^^^^^^^^^^^^^^^^^^^^^^
106109

107110
libmongocrypt is continuously built and published on evergreen.
108111
The latest tarball containing libmongocrypt built on all supported variants is
@@ -142,6 +145,9 @@ Linux: set the libmongocrypt build for your platform, for example for Ubuntu 22.
142145
$ export PYMONGOCRYPT_LIB=$(pwd)/libmongocrypt-all/ubuntu2204-64/lib/libmongocrypt.so
143146
$ python -c "import pymongocrypt; print(pymongocrypt.libmongocrypt_version())"
144147
1.9.0
148+
$ # Check that native crypto is enabled for better performance:
149+
$ python -c 'from pymongocrypt.binding import lib;print(lib.mongocrypt_is_crypto_available())'
150+
True
145151

146152
Note if your Linux platform is not available, the generic RHEL 6.2 x86_64 "nocrypto" build
147153
should still be compatible however the "nocrypto" build will result in lower performance
@@ -151,6 +157,11 @@ for encryption and decryption::
151157
$ export PYMONGOCRYPT_LIB=$(pwd)/libmongocrypt-all/rhel-62-64-bit/nocrypto/lib64/libmongocrypt.so
152158
$ python -c "import pymongocrypt; print(pymongocrypt.libmongocrypt_version())"
153159
1.9.0
160+
$ python -c 'from pymongocrypt.binding import lib;print(lib.mongocrypt_is_crypto_available())'
161+
False
162+
163+
Other methods of installation (brew, rpm, yum, apt-get, deb, etc...) are documented here:
164+
https://www.mongodb.com/docs/manual/core/csfle/reference/libmongocrypt/#linux-installation
154165

155166
Dependencies
156167
============

0 commit comments

Comments
 (0)