Need help with slowapi?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

laurentS
305 Stars 22 Forks MIT License 115 Commits 16 Opened issues

Description

A rate limiter for Starlette and FastAPI

Services available

!
?

Need anything else?

Contributors list

# 250,010
Shell
Firebas...
starlet...
fastapi
56 commits
# 236,961
Svelte
golang
vuejs
Postgre...
7 commits
# 465,241
PHP
C++
Shell
starlet...
6 commits
# 418,106
Python
Shell
fastapi
starlet...
6 commits
# 36,831
openapi
swagger
starlet...
python3
2 commits
# 265,843
CSS
HTML
Shell
rate-li...
1 commit
# 6,458
vuejs
vuejs2
Docker
Visual ...
1 commit
# 512
Python
Django
Raspber...
hass
1 commit

SlowApi

A rate limiting library for Starlette and FastAPI adapted from flask-limiter.

Note: this is alpha quality code still, the API may change, and things may fall apart while you try it.

The documentation is on read the docs.

Quick start

Installation

slowapi
is available from pypi so you can install it as usual:
$ pip install slowapi

Features

Most feature are coming from FlaskLimiter and the underlying limits.

Supported now:

  • Single and multiple
    limit
    decorator on endpoint functions to apply limits
  • redis, memcached and memory backends to track your limits (memory as a fallback)
  • support for sync and async HTTP endpoints
  • Support for shared limits across a set of routes

Limitations and known issues

  • The
    request
    argument must be explicitly passed to your endpoint, or
    slowapi
    won't be able to hook into it. In other words, write:
    @limiter.limit("5/minute")
    async def myendpoint(request: Request)
        pass

and not:

    @limiter.limit("5/minute")
    async def myendpoint()
        pass
  • websocket
    endpoints are not supported yet.

Developing and contributing

PRs are more than welcome! Please include tests for your changes :)

The package uses poetry to manage dependencies. To setup your dev env:

$ poetry install

To run the tests:

bash
$ pytest

Credits

Credits go to flask-limiter of which SlowApi is a (still partial) adaptation to Starlette and FastAPI. It's also important to mention that the actual rate limiting work is done by limits,

slowapi
is just a wrapper around it.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.