Flask-RateLimiter

travis-ci badge coveralls.io badge

Flask-RateLimiter is a Flask extension that provides rate limiting decorator.

CAVEAT LECTOR

Flask-RateLimiter is now deprecated in favour of Flask-Limiter

Contents

Installation

Flask-RateLimiter is on PyPI so all you need is:

$ pip install flask-ratelimiter

The development version can be downloaded from its page at GitHub.

$ git clone https://github.com/inveniosoftware/flask-ratelimiter.git
$ cd flask-ratelimiter
$ python setup.py develop
$ ./run-tests.sh

Requirements

Flask-RateLimiter has the following dependencies:

Flask-RateLimiter requires Python version 2.6, 2.7 or 3.3+

API

This documentation section is automatically generated from Flask-RateLimiter’s source code.

Changes

Here you can see the full list of changes between each Flask-RateLimiter release.

Version 0.2.0 (released 2014-12-16)

  • The Flask-RateLimiter extension is now released under more permissive Revised BSD License. (#8)
  • Minor documentation updates. (#4)
  • Optionally callable limit argument. (#9)
  • Redis backend accepts keyword arguments from RATELIMITER_BACKEND_OPTIONS config variable. (#12 #13)

Version 0.1.0 (released 2014-06-27)

  • Initial public release.

Contributing

Bug reports, feature requests, and other contributions are welcome. If you find a demonstrable problem that is caused by the code of this library, please:

  1. Search for already reported problems.
  2. Check if the issue has been fixed or is still reproducible on the latest master branch.
  3. Create an issue with a test case.

If you create a feature branch, you can run the tests to ensure everything is operating correctly:

$ ./run-tests.sh

License

Flask-RateLimiter is free software; you can redistribute it and/or modify it under the terms of the Revised BSD License quoted below.

Copyright (C) 2013, 2014 CERN.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

In applying this license, CERN does not waive the privileges and immunities granted to it by virtue of its status as an Intergovernmental Organization or submit itself to any jurisdiction.

Authors

Flask-RateLimiter is developed for use in Invenio digital library software.

Contact us at info@inveniosoftware.org