{"author":"Ali-Akber Saifee","author_email":"ali@indydevs.org","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Environment :: Web Environment","Framework :: Flask","Intended Audience :: Developers","License :: OSI Approved :: MIT License","Operating System :: MacOS","Operating System :: OS Independent","Operating System :: POSIX :: Linux","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.13","Topic :: Software Development :: Libraries :: Python Modules"],"description":".. |ci| image:: https://github.com/alisaifee/flask-limiter/actions/workflows/main.yml/badge.svg?branch=master\n :target: https://github.com/alisaifee/flask-limiter/actions?query=branch%3Amaster+workflow%3ACI\n.. |codecov| image:: https://codecov.io/gh/alisaifee/flask-limiter/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/alisaifee/flask-limiter\n.. |pypi| image:: https://img.shields.io/pypi/v/Flask-Limiter.svg?style=flat-square\n :target: https://pypi.python.org/pypi/Flask-Limiter\n.. |license| image:: https://img.shields.io/pypi/l/Flask-Limiter.svg?style=flat-square\n :target: https://pypi.python.org/pypi/Flask-Limiter\n.. |docs| image:: https://readthedocs.org/projects/flask-limiter/badge/?version=latest\n :target: https://flask-limiter.readthedocs.org/en/latest\n\n*************\nFlask-Limiter\n*************\n\n\n|docs| |ci| |codecov| |pypi| |license|\n\n**Flask-Limiter** adds rate limiting to `Flask `_ applications.\n\nYou can configure rate limits at different levels such as:\n\n- Application wide global limits per user\n- Default limits per route\n- By `Blueprints `_\n- By `Class-based views `_\n- By `individual routes `_\n\n**Flask-Limiter** can be `configured `_ to fit your application in many ways, including:\n\n- Persistance to various commonly used `storage backends `_\n (such as Redis, Memcached & MongoDB)\n via `limits `__\n- Any rate limiting strategy supported by `limits `__\n\nFollow the quickstart below to get started or `read the documentation `_ for more details.\n\n\nQuickstart\n===========\n\nInstall\n-------\n.. code-block:: bash\n\n pip install Flask-Limiter\n\nAdd the rate limiter to your flask app\n---------------------------------------\n.. code-block:: python\n\n # app.py\n\n from flask import Flask\n from flask_limiter import Limiter\n from flask_limiter.util import get_remote_address\n\n app = Flask(__name__)\n limiter = Limiter(\n get_remote_address,\n app=app,\n default_limits=[\"2 per minute\", \"1 per second\"],\n storage_uri=\"memory://\",\n # Redis\n # storage_uri=\"redis://localhost:6379\",\n # Redis cluster\n # storage_uri=\"redis+cluster://localhost:7000,localhost:7001,localhost:70002\",\n # Memcached\n # storage_uri=\"memcached://localhost:11211\",\n # Memcached Cluster\n # storage_uri=\"memcached://localhost:11211,localhost:11212,localhost:11213\",\n # MongoDB\n # storage_uri=\"mongodb://localhost:27017\",\n strategy=\"fixed-window\", # or \"moving-window\", or \"sliding-window-counter\"\n )\n\n @app.route(\"/slow\")\n @limiter.limit(\"1 per day\")\n def slow():\n return \"24\"\n\n @app.route(\"/fast\")\n def fast():\n return \"42\"\n\n @app.route(\"/ping\")\n @limiter.exempt\n def ping():\n return 'PONG'\n\nInspect the limits using the command line interface\n---------------------------------------------------\n.. code-block:: bash\n\n $ FLASK_APP=app:app flask limiter limits\n\n app\n ├── fast: /fast\n │ ├── 2 per 1 minute\n │ └── 1 per 1 second\n ├── ping: /ping\n │ └── Exempt\n └── slow: /slow\n └── 1 per 1 day\n\nRun the app\n-----------\n.. code-block:: bash\n\n $ FLASK_APP=app:app flask run\n\n\nTest it out\n-----------\nThe ``fast`` endpoint respects the default rate limit while the\n``slow`` endpoint uses the decorated one. ``ping`` has no rate limit associated\nwith it.\n\n.. code-block:: bash\n\n $ curl localhost:5000/fast\n 42\n $ curl localhost:5000/fast\n 42\n $ curl localhost:5000/fast\n \n 429 Too Many Requests\n

Too Many Requests

2 per 1 minute

\n $ curl localhost:5000/slow\n 24\n $ curl localhost:5000/slow\n \n 429 Too Many Requests\n

Too Many Requests

1 per 1 day

\n $ curl localhost:5000/ping\n PONG\n $ curl localhost:5000/ping\n PONG\n $ curl localhost:5000/ping\n PONG\n $ curl localhost:5000/ping\n PONG\n\n\n\n\n","description_content_type":null,"docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":["Author","Author-Email","Classifier","Description","Home-Page","License","Project-Url","Provides-Extra","Requires-Dist","Requires-Python","Summary"],"home_page":"https://flask-limiter.readthedocs.org","keywords":null,"license":"MIT","license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"Flask-Limiter","package_url":"https://pypi.org/project/Flask-Limiter/","platform":null,"project_url":"https://pypi.org/project/Flask-Limiter/","project_urls":{"Homepage":"https://flask-limiter.readthedocs.org","Source":"https://github.com/alisaifee/flask-limiter"},"provides_extra":["redis","memcached","mongodb","valkey"],"release_url":"https://pypi.org/project/Flask-Limiter/3.12/","requires_dist":["limits>=3.13","Flask>=2","ordered-set<5,>4","rich<14,>=12","limits[redis]; extra == \"redis\"","limits[memcached]; extra == \"memcached\"","limits[mongodb]; extra == \"mongodb\"","limits[valkey]; extra == \"valkey\""],"requires_python":">=3.10","summary":"Rate limiting for flask applications","version":"3.12","yanked":false,"yanked_reason":null}

Dependencies of Flask-Limiter (4).
Dependency	Optional
Flask	false
limits	false
ordered-set	false
rich	false

Package search

Flask-Limiter

project_urls

Dependencies

All package metadata

Releases