Added github integration
This commit is contained in:
@@ -0,0 +1 @@
|
||||
pip
|
||||
@@ -0,0 +1,187 @@
|
||||
Metadata-Version: 2.4
|
||||
Name: Flask-Limiter
|
||||
Version: 4.0.0
|
||||
Summary: Rate limiting for flask applications
|
||||
Project-URL: Homepage, https://flask-limiter.readthedocs.org
|
||||
Project-URL: Source, https://github.com/alisaifee/flask-limiter
|
||||
Project-URL: Documentation, https://flask-limiter.readthedocs.org
|
||||
Author-email: Ali-Akber Saifee <ali@indydevs.org>
|
||||
Maintainer-email: Ali-Akber Saifee <ali@indydevs.org>
|
||||
License-Expression: MIT
|
||||
License-File: LICENSE.txt
|
||||
Classifier: Development Status :: 5 - Production/Stable
|
||||
Classifier: Environment :: Web Environment
|
||||
Classifier: Framework :: Flask
|
||||
Classifier: Intended Audience :: Developers
|
||||
Classifier: Operating System :: MacOS
|
||||
Classifier: Operating System :: OS Independent
|
||||
Classifier: Operating System :: POSIX :: Linux
|
||||
Classifier: Programming Language :: Python :: 3.10
|
||||
Classifier: Programming Language :: Python :: 3.11
|
||||
Classifier: Programming Language :: Python :: 3.12
|
||||
Classifier: Programming Language :: Python :: 3.13
|
||||
Classifier: Topic :: Software Development :: Libraries :: Python Modules
|
||||
Requires-Python: >=3.10
|
||||
Requires-Dist: flask>=2
|
||||
Requires-Dist: limits>=3.13
|
||||
Requires-Dist: ordered-set<5,>4
|
||||
Requires-Dist: rich<15,>=12
|
||||
Requires-Dist: typing-extensions>=4.3
|
||||
Provides-Extra: memcached
|
||||
Requires-Dist: limits[memcached]; extra == 'memcached'
|
||||
Provides-Extra: mongodb
|
||||
Requires-Dist: limits[mongodb]; extra == 'mongodb'
|
||||
Provides-Extra: redis
|
||||
Requires-Dist: limits[redis]; extra == 'redis'
|
||||
Provides-Extra: valkey
|
||||
Requires-Dist: limits[valkey]; extra == 'valkey'
|
||||
Description-Content-Type: text/x-rst
|
||||
|
||||
.. |ci| image:: https://github.com/alisaifee/flask-limiter/actions/workflows/main.yml/badge.svg?branch=master
|
||||
:target: https://github.com/alisaifee/flask-limiter/actions?query=branch%3Amaster+workflow%3ACI
|
||||
.. |codecov| image:: https://codecov.io/gh/alisaifee/flask-limiter/branch/master/graph/badge.svg
|
||||
:target: https://codecov.io/gh/alisaifee/flask-limiter
|
||||
.. |pypi| image:: https://img.shields.io/pypi/v/Flask-Limiter.svg?style=flat-square
|
||||
:target: https://pypi.python.org/pypi/Flask-Limiter
|
||||
.. |license| image:: https://img.shields.io/pypi/l/Flask-Limiter.svg?style=flat-square
|
||||
:target: https://pypi.python.org/pypi/Flask-Limiter
|
||||
.. |docs| image:: https://readthedocs.org/projects/flask-limiter/badge/?version=latest
|
||||
:target: https://flask-limiter.readthedocs.org/en/latest
|
||||
|
||||
*************
|
||||
Flask-Limiter
|
||||
*************
|
||||
|
||||
|
||||
|docs| |ci| |codecov| |pypi| |license|
|
||||
|
||||
**Flask-Limiter** adds rate limiting to `Flask <https://flask.palletsprojects.com>`_ applications.
|
||||
|
||||
You can configure rate limits at different levels such as:
|
||||
|
||||
- Application wide global limits per user
|
||||
- Default limits per route
|
||||
- By `Blueprints <https://flask-limiter.readthedocs.io/en/latest/recipes.html#rate-limiting-all-routes-in-a-blueprint>`_
|
||||
- By `Class-based views <https://flask-limiter.readthedocs.io/en/latest/recipes.html#using-flask-pluggable-views>`_
|
||||
- By `individual routes <https://flask-limiter.readthedocs.io/en/latest/index.html#decorators-to-declare-rate-limits>`_
|
||||
|
||||
**Flask-Limiter** can be `configured <https://flask-limiter.readthedocs.io/en/latest/configuration.html>`_ to fit your application in many ways, including:
|
||||
|
||||
- Persistance to various commonly used `storage backends <https://flask-limiter.readthedocs.io/en/latest/#configuring-a-storage-backend>`_
|
||||
(such as Redis, Memcached & MongoDB)
|
||||
via `limits <https://limits.readthedocs.io/en/stable/storage.html>`__
|
||||
- Any rate limiting strategy supported by `limits <https://limits.readthedocs.io/en/stable/strategies.html>`__
|
||||
|
||||
Follow the quickstart below to get started or `read the documentation <http://flask-limiter.readthedocs.org/en/latest>`_ for more details.
|
||||
|
||||
|
||||
Quickstart
|
||||
===========
|
||||
|
||||
Install
|
||||
-------
|
||||
.. code-block:: bash
|
||||
|
||||
pip install Flask-Limiter
|
||||
|
||||
Add the rate limiter to your flask app
|
||||
---------------------------------------
|
||||
.. code-block:: python
|
||||
|
||||
# app.py
|
||||
|
||||
from flask import Flask
|
||||
from flask_limiter import Limiter
|
||||
from flask_limiter.util import get_remote_address
|
||||
|
||||
app = Flask(__name__)
|
||||
limiter = Limiter(
|
||||
get_remote_address,
|
||||
app=app,
|
||||
default_limits=["2 per minute", "1 per second"],
|
||||
storage_uri="memory://",
|
||||
# Redis
|
||||
# storage_uri="redis://localhost:6379",
|
||||
# Redis cluster
|
||||
# storage_uri="redis+cluster://localhost:7000,localhost:7001,localhost:70002",
|
||||
# Memcached
|
||||
# storage_uri="memcached://localhost:11211",
|
||||
# Memcached Cluster
|
||||
# storage_uri="memcached://localhost:11211,localhost:11212,localhost:11213",
|
||||
# MongoDB
|
||||
# storage_uri="mongodb://localhost:27017",
|
||||
strategy="fixed-window", # or "moving-window", or "sliding-window-counter"
|
||||
)
|
||||
|
||||
@app.route("/slow")
|
||||
@limiter.limit("1 per day")
|
||||
def slow():
|
||||
return "24"
|
||||
|
||||
@app.route("/fast")
|
||||
def fast():
|
||||
return "42"
|
||||
|
||||
@app.route("/ping")
|
||||
@limiter.exempt
|
||||
def ping():
|
||||
return 'PONG'
|
||||
|
||||
Inspect the limits using the command line interface
|
||||
---------------------------------------------------
|
||||
.. code-block:: bash
|
||||
|
||||
$ FLASK_APP=app:app flask limiter limits
|
||||
|
||||
app
|
||||
├── fast: /fast
|
||||
│ ├── 2 per 1 minute
|
||||
│ └── 1 per 1 second
|
||||
├── ping: /ping
|
||||
│ └── Exempt
|
||||
└── slow: /slow
|
||||
└── 1 per 1 day
|
||||
|
||||
Run the app
|
||||
-----------
|
||||
.. code-block:: bash
|
||||
|
||||
$ FLASK_APP=app:app flask run
|
||||
|
||||
|
||||
Test it out
|
||||
-----------
|
||||
The ``fast`` endpoint respects the default rate limit while the
|
||||
``slow`` endpoint uses the decorated one. ``ping`` has no rate limit associated
|
||||
with it.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ curl localhost:5000/fast
|
||||
42
|
||||
$ curl localhost:5000/fast
|
||||
42
|
||||
$ curl localhost:5000/fast
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
||||
<title>429 Too Many Requests</title>
|
||||
<h1>Too Many Requests</h1>
|
||||
<p>2 per 1 minute</p>
|
||||
$ curl localhost:5000/slow
|
||||
24
|
||||
$ curl localhost:5000/slow
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
||||
<title>429 Too Many Requests</title>
|
||||
<h1>Too Many Requests</h1>
|
||||
<p>1 per 1 day</p>
|
||||
$ curl localhost:5000/ping
|
||||
PONG
|
||||
$ curl localhost:5000/ping
|
||||
PONG
|
||||
$ curl localhost:5000/ping
|
||||
PONG
|
||||
$ curl localhost:5000/ping
|
||||
PONG
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
flask_limiter-4.0.0.dist-info/INSTALLER,sha256=zuuue4knoyJ-UwPPXg8fezS7VCrXJQrAP7zeNuwvFQg,4
|
||||
flask_limiter-4.0.0.dist-info/METADATA,sha256=z4cnwjhUEqIaZahFGB30-x1V4Lg_jy5q11Voh_bAMfQ,6190
|
||||
flask_limiter-4.0.0.dist-info/RECORD,,
|
||||
flask_limiter-4.0.0.dist-info/REQUESTED,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
||||
flask_limiter-4.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
|
||||
flask_limiter-4.0.0.dist-info/entry_points.txt,sha256=XP1DLGAtSzSTO-1e0l2FR9chlucKvsGCgh_wfCO9oj8,54
|
||||
flask_limiter-4.0.0.dist-info/licenses/LICENSE.txt,sha256=T6i7kq7F5gIPfcno9FCxU5Hcwm22Bjq0uHZV3ElcjsQ,1061
|
||||
flask_limiter/__init__.py,sha256=bRCHLQM_WY2FAIUOJhTtb3VQ6OXqq79lMz80uub6TNs,557
|
||||
flask_limiter/__pycache__/__init__.cpython-311.pyc,,
|
||||
flask_limiter/__pycache__/_compat.cpython-311.pyc,,
|
||||
flask_limiter/__pycache__/_extension.cpython-311.pyc,,
|
||||
flask_limiter/__pycache__/_limits.cpython-311.pyc,,
|
||||
flask_limiter/__pycache__/_manager.cpython-311.pyc,,
|
||||
flask_limiter/__pycache__/_typing.cpython-311.pyc,,
|
||||
flask_limiter/__pycache__/_version.cpython-311.pyc,,
|
||||
flask_limiter/__pycache__/commands.cpython-311.pyc,,
|
||||
flask_limiter/__pycache__/constants.cpython-311.pyc,,
|
||||
flask_limiter/__pycache__/errors.cpython-311.pyc,,
|
||||
flask_limiter/__pycache__/util.cpython-311.pyc,,
|
||||
flask_limiter/_compat.py,sha256=jrUYRoIo4jOXp5JDWgpL77F6Cuj_0iX7ySsTOfYrPs8,379
|
||||
flask_limiter/_extension.py,sha256=QNu9R0u0J2x8Qr9YkOYys3fGA8sLPtX6ZnfZ6lgCG8U,48057
|
||||
flask_limiter/_limits.py,sha256=sJn-5OLYkeS2GfYVkbdSb5flbFidHJnNndCGgbAnYyg,15006
|
||||
flask_limiter/_manager.py,sha256=RJhFo30P8rfNiOtKiKZBUfL1ZYAmuPoXUbsZ4ILB1ew,10453
|
||||
flask_limiter/_typing.py,sha256=yrxK2Zu1sZ3ojvwJMfkJVVawGOzGVsfxAbUG8I5TkBo,401
|
||||
flask_limiter/_version.py,sha256=QKIQLQcx5S9GHF_rplWSVpBW_nVDWWvM96YNckz0xJI,704
|
||||
flask_limiter/_version.pyi,sha256=Y25n44pyE3vp92MiABKrcK3IWRyQ1JG1rZ4Ufqy2nC0,17
|
||||
flask_limiter/commands.py,sha256=meE7MIH0fezy7NnhKGUujsNFlVpCWEZqnu5qoXotseo,22463
|
||||
flask_limiter/constants.py,sha256=-e1Ff1g938ajdgR8f-oWVp3bjLSdy2pPOQdV3RsUHAs,2902
|
||||
flask_limiter/contrib/__init__.py,sha256=Yr06Iy3i_F1cwTSGcGWOxMHOZaQnySiRFBfsH8Syric,28
|
||||
flask_limiter/contrib/__pycache__/__init__.cpython-311.pyc,,
|
||||
flask_limiter/contrib/__pycache__/util.cpython-311.pyc,,
|
||||
flask_limiter/contrib/util.py,sha256=XKX5pqA7f-cGP7IQtg2tnyoQk2Eh5L4Hi3zDpWjq_3s,306
|
||||
flask_limiter/errors.py,sha256=mDP2C-SFxaP9ErSZCbSiNmM6RbEZG38EPPPkZELx4K4,1066
|
||||
flask_limiter/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
||||
flask_limiter/util.py,sha256=KwLYUluQR2M9dGZppqqczdtUjNiuv2zh_lB_gaDMzcw,975
|
||||
@@ -0,0 +1,4 @@
|
||||
Wheel-Version: 1.0
|
||||
Generator: hatchling 1.27.0
|
||||
Root-Is-Purelib: true
|
||||
Tag: py3-none-any
|
||||
@@ -0,0 +1,2 @@
|
||||
[flask.commands]
|
||||
limiter = flask_limiter.commands:cli
|
||||
@@ -0,0 +1,20 @@
|
||||
Copyright (c) 2023 Ali-Akber Saifee
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights to
|
||||
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
|
||||
of the Software, and to permit persons to whom the Software is furnished to do
|
||||
so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
Reference in New Issue
Block a user