aiolimiter1.1.0
Published
asyncio rate limiter, a leaky bucket implementation
pip install aiolimiter
Package Downloads
Authors
Requires Python
>=3.7,<4.0
aiolimiter
Introduction
An efficient implementation of a rate limiter for asyncio.
This project implements the Leaky bucket algorithm, giving you precise control over the rate a code section can be entered:
from aiolimiter import AsyncLimiter
# allow for 100 concurrent entries within a 30 second window
rate_limit = AsyncLimiter(100, 30)
async def some_coroutine():
async with rate_limit:
# this section is *at most* going to entered 100 times
# in a 30 second period.
await do_something()
It was first developed as an answer on Stack Overflow.
Documentation
https://aiolimiter.readthedocs.io
Installation
$ pip install aiolimiter
The library requires Python 3.7 or newer.
Requirements
- Python >= 3.7
License
aiolimiter
is offered under the MIT license.
Source code
The project is hosted on GitHub.
Please file an issue in the bug tracker if you have found a bug or have some suggestions to improve the library.
Developer setup
This project uses poetry to manage dependencies, testing and releases. Make sure you have installed that tool, then run the following command to get set up:
poetry install --with docs && poetry run doit devsetup
Apart from using poetry run doit devsetup
, you can either use poetry shell
to enter a shell environment with a virtualenv set up for you, or use poetry run ...
to run commands within the virtualenv.
Tests are run with pytest
and tox
. Releases are made with poetry build
and poetry publish
. Code quality is maintained with flake8
, black
and mypy
, and pre-commit
runs quick checks to maintain the standards set.
A series of doit
tasks are defined; run poetry run doit list
(or doit list
with poetry shell
activated) to list them. The default action is to run a full linting, testing and building run. It is recommended you run this before creating a pull request.