Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wemake-services/asyncio-redis-rate-limit
Rate limiter for async functions using Redis as a backend.
https://github.com/wemake-services/asyncio-redis-rate-limit
aiohttp aioredis asyncio httpx python python3 rate-limit rate-limiter rate-limiting ratelimit redis redispy
Last synced: 4 days ago
JSON representation
Rate limiter for async functions using Redis as a backend.
- Host: GitHub
- URL: https://github.com/wemake-services/asyncio-redis-rate-limit
- Owner: wemake-services
- License: mit
- Created: 2022-06-22T22:01:20.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-09T09:12:40.000Z (7 months ago)
- Last Synced: 2024-04-14T00:25:48.293Z (7 months ago)
- Topics: aiohttp, aioredis, asyncio, httpx, python, python3, rate-limit, rate-limiter, rate-limiting, ratelimit, redis, redispy
- Language: Python
- Homepage: https://pypi.org/project/asyncio-redis-rate-limit/
- Size: 629 KB
- Stars: 33
- Watchers: 3
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# asyncio-redis-rate-limit
[](https://wemake-services.github.io)
[](https://github.com/wemake-services/asyncio-redis-rate-limit/actions?query=workflow%3Atest)
[](https://codecov.io/gh/wemake-services/asyncio-redis-rate-limit)
[](https://pypi.org/project/asyncio-redis-rate-limit/)
[](https://github.com/wemake-services/wemake-python-styleguide)
Rate limiter for async functions using Redis as a backend.
## Features
- Small and simple
- Can be used as a decorator or as a context manager
- Can be used for both clients and servers
- Works with `asyncio`
- Works with any amount of processes
- Works with both [`redis.asyncio.client.Redis`](https://redis-py.readthedocs.io/en/stable/examples/asyncio_examples.html) and [`aioredis`](https://github.com/aio-libs/aioredis-py)
- Free of race-conditions (hopefully!)
- Supports `redis` since `7.0`
- Fully typed with annotations and checked with mypy, [PEP561 compatible](https://www.python.org/dev/peps/pep-0561/)
## Installation
```bash
pip install asyncio-redis-rate-limit
```
Extras available:
- `pip install asyncio-redis-rate-limit[redis]`
- `pip install asyncio-redis-rate-limit[aioredis]` (for python versions `<3.11`)
## Example
As a decorator:
```python
>>> from asyncio_redis_rate_limit import rate_limit, RateSpec
>>> from redis.asyncio import Redis as AsyncRedis # pip install redis
>>> redis = AsyncRedis.from_url('redis://localhost:6379')
>>> @rate_limit(
... rate_spec=RateSpec(requests=1200, seconds=60),
... backend=redis,
... )
... async def request() -> ...:
... ... # Do something useful! Call this function as usual.
```
Or as a context manager:
```python
>>> from asyncio_redis_rate_limit import RateLimiter, RateSpec
>>> from redis.asyncio import Redis as AsyncRedis # pip install redis
>>> redis = AsyncRedis.from_url('redis://localhost:6379')
>>> async def request() -> ...:
... async with RateLimiter(
... unique_key='api-name.com',
... backend=redis,
... rate_spec=RateSpec(requests=5, seconds=1),
... ):
... ... # Do the request itself.
```
## License
[MIT](https://github.com/wemake-services/asyncio-redis-rate-limit/blob/master/LICENSE)
## Credits
This project was generated with [`wemake-python-package`](https://github.com/wemake-services/wemake-python-package). Current template version is: [1d63652fbb33ebe2f6d932f511b7f529a4ce2d2a](https://github.com/wemake-services/wemake-python-package/tree/1d63652fbb33ebe2f6d932f511b7f529a4ce2d2a). See what is [updated](https://github.com/wemake-services/wemake-python-package/compare/1d63652fbb33ebe2f6d932f511b7f529a4ce2d2a...master) since then.