MOTOR-884 Mirror all PyMongo extras (#148)

This commit is contained in:
Tushar Singh 2022-03-10 02:43:02 +05:30 committed by GitHub
parent 13b82efa1d
commit 64fbc8313b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 111 additions and 1 deletions

View File

@ -101,6 +101,47 @@ asyncio. It requires:
* PyMongo_ >=3.12,<4
* Python 3.5+
Optional dependencies:
Motor supports same optional dependencies as PyMongo. Required dependencies can be installed
along with Motor.
GSSAPI authentication requires ``gssapi`` extra dependency. The correct
dependency can be installed automatically along with Motor::
$ pip install "motor[gssapi]"
similarly,
MONGODB-AWS authentication requires ``aws`` extra dependency::
$ pip install "motor[aws]"
Support for mongodb+srv:// URIs requires ``srv`` extra dependency::
$ pip install "motor[srv]"
OCSP requires ``ocsp`` extra dependency::
$ pip install "motor[ocsp]"
Wire protocol compression with snappy requires ``snappy`` extra dependency::
$ pip install "motor[snappy]"
Wire protocol compression with zstandard requires ``zstd`` extra dependency::
$ pip install "motor[zstd]"
Client-Side Field Level Encryption requires ``encryption`` extra dependency::
$ pip install "motor[encryption]"
You can install all dependencies automatically with the following
command::
$ pip install "motor[gssapi,aws,ocsp,snappy,srv,zstd,encryption]"
See `requirements <https://motor.readthedocs.io/en/stable/requirements.html>`_
for details about compatibility.

View File

@ -14,3 +14,4 @@ The following is a list of people who have contributed to
- Shane Harvey
- Bulat Khasanov
- William Zhou
- Tushar Singh

View File

@ -12,6 +12,66 @@ To install Motor from sources, you can clone its git repository and do::
$ python3 -m pip install .
Dependencies
------------
Motor works in all the environments officially supported by Tornado or by
asyncio. It requires:
* Unix (including macOS) or Windows.
* PyMongo_ >=3.12,<4
* Python 3.5+
Optional dependencies:
Motor supports same optional dependencies as PyMongo. Required dependencies can be installed
along with Motor.
GSSAPI authentication requires ``gssapi`` extra dependency. The correct
dependency can be installed automatically along with Motor::
$ pip install "motor[gssapi]"
similarly,
`MONGODB-AWS <https://pymongo.readthedocs.io/en/stable/examples/authentication.html#mongodb-aws>`_
authentication requires ``aws`` extra dependency::
$ pip install "motor[aws]"
Support for mongodb+srv:// URIs requires ``srv`` extra dependency::
$ pip install "motor[srv]"
`OCSP <https://pymongo.readthedocs.io/en/stable/examples/tls.html#ocsp>`_ requires ``ocsp`` extra dependency::
$ pip install "motor[ocsp]"
Wire protocol compression with snappy requires ``snappy`` extra dependency::
$ pip install "motor[snappy]"
Wire protocol compression with zstandard requires ``zstd`` extra dependency::
$ pip install "motor[zstd]"
`Client-Side Field Level Encryption
<https://pymongo.readthedocs.io/en/stable/examples/encryption.html#client-side-field-level-encryption>`_
requires ``encryption`` extra dependency::
$ pip install "motor[encryption]"
You can install all dependencies automatically with the following
command::
$ pip install "motor[gssapi,aws,ocsp,snappy,srv,zstd,encryption]"
See `requirements <https://motor.readthedocs.io/en/stable/requirements.html>`_
for details about compatibility.
.. _PyPI: http://pypi.python.org/pypi/motor
.. _pip: http://pip-installer.org
.. _PyMongo: http://pypi.python.org/pypi/pymongo/

View File

@ -36,7 +36,15 @@ pymongo_ver = ">=3.12,<5"
install_requires = ["pymongo" + pymongo_ver]
extras_require = {"encryption": ["pymongo[encryption]" + pymongo_ver]}
extras_require = {
"encryption": ["pymongo[encryption]" + pymongo_ver],
"ocsp": ["pymongo[ocsp]" + pymongo_ver],
"snappy": ["pymongo[snappy]" + pymongo_ver],
"zstd": ["pymongo[zstd]" + pymongo_ver],
"aws": ["pymongo[aws]" + pymongo_ver],
"srv": ["pymongo[srv]" + pymongo_ver],
"gssapi": ["pymongo[gssapi]" + pymongo_ver],
}
tests_require = ["mockupdb>=1.4.0"]