Metadata-Version: 2.1
Name: asynciolimiter
Version: 1.0.0b1
Summary: Rate limiter for Async IO
Author: Bar Harel
Author-email: bzvi7919@gmail.com
License: MIT
Project-URL: Documentation, https://asynciolimiter.readthedocs.io/en/latest/
Project-URL: Source, https://github.com/bharel/asynciolimiter
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: build
Requires-Dist: wheel ; extra == 'build'
Requires-Dist: twine ; extra == 'build'
Requires-Dist: sphinx ; extra == 'build'

# asynciolimiter
A simple Python AsyncIO rate limiter.

![GitHub branch checks state](https://img.shields.io/github/checks-status/bharel/asynciolimiter/master)
![PyPI](https://img.shields.io/pypi/v/asynciolimiter)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/asynciolimiter)
[![codecov](https://codecov.io/gh/bharel/asynciolimiter/branch/master/graph/badge.svg?token=BJBL909NH3)](https://codecov.io/gh/bharel/asynciolimiter)

## Installation
`pip install asynciolimiter`

## Sample Usage

```python
# Limit to 10 requests per 5 second (equiv to 2 requests per second)
>>> limiter = asynciolimiter.Limiter(10/5)
>>> async def main():
...     await limiter.wait() # Wait for a slot to be available.
...     pass # do stuff

>>> limiter = Limiter(1/3)
>>> async def request():
...     await limiter.wait()
...     print("Request")  # Do stuff
...
>>> async def main():
...     # Schedule 1 request every 3 seconds.
...     await asyncio.gather(*(request() for _ in range(10)))
```

## Available Limiter flavors

- `Limiter`: Limits by requests per second and takes into account CPU heavy
    tasks or other delays that can occur while the process is sleeping.
- `LeakyBucketLimiter`: Limits by requests per second according to the
    leaky bucket algorithm. Has a maximum capacity and an initial burst of
    requests.
- `StrictLimiter`: Limits by requests per second, without taking CPU or other
    process sleeps into account. There are no bursts and the resulting rate will
    always be a less than the set limit.

## Documentation

Full documentation available on [Read the Docs](https://asynciolimiter.readthedocs.io/en/latest/).

## License

Licensed under the MIT License.

