1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
|
============
Installation
============
Install the package with pip:
.. code:: console
$ pip install limits
.. tab:: Redis
.. code:: console
$ pip install limits[redis]
Includes
.. literalinclude:: ../../requirements/storage/redis.txt
.. tab:: RedisCluster
.. code:: console
$ pip install limits[rediscluster]
Includes
.. literalinclude:: ../../requirements/storage/rediscluster.txt
.. tab:: Memcached
.. code:: console
$ pip install limits[memcached]
Includes
.. literalinclude:: ../../requirements/storage/memcached.txt
.. tab:: MongoDB
.. code:: console
$ pip install limits[mongodb]
Includes:
.. literalinclude:: ../../requirements/storage/mongodb.txt
.. tab:: Etcd
.. code:: console
$ pip install limits[etcd]
Includes:
.. literalinclude:: ../../requirements/storage/etcd.txt
.. tab:: Valkey
.. code:: console
$ pip install limits[valkey]
Includes:
.. literalinclude:: ../../requirements/storage/valkey.txt
More details around the specifics of each storage backend can be
found in :ref:`storage`
Async Storage
=============
If you are using an async code base you can install the storage dependencies
along with the package using the following extras:
.. tab:: Redis
.. code:: console
$ pip install limits[async-redis]
Includes:
.. literalinclude:: ../../requirements/storage/async-redis.txt
.. versionadded:: 4.2
:pypi:`redis` if installed can be used instead of :pypi:`coredis` by setting
:paramref:`~limits.aio.storage.Redis.implementation` to ``redispy``.
See :class:`limits.aio.storage.RedisStorage` for more details.
.. tab:: Memcached
.. code:: console
$ pip install limits[async-memcached]
Includes:
.. literalinclude:: ../../requirements/storage/async-memcached.txt
.. tab:: MongoDB
.. code:: console
$ pip install limits[async-mongodb]
Includes:
.. literalinclude:: ../../requirements/storage/async-mongodb.txt
.. tab:: Etcd
.. code:: console
$ pip install limits[async-etcd]
Includes:
.. literalinclude:: ../../requirements/storage/async-etcd.txt
.. tab:: Valkey
.. code:: console
$ pip install limits[async-valkey]
Includes:
.. literalinclude:: ../../requirements/storage/async-valkey.txt
|