Metadata-Version: 2.1
Name: Function-Limiter
Version: 0.0.8.3
Summary: Rate limiting for callable functions
Home-page: https://github.com/mghorbani2357/Function-Limiter
Author: Mohsen Ghorbani
Author-email: m.ghorbani2357@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: Implementation :: PyPy
Description-Content-Type: text/x-rst
Requires-Dist: redis (~=3.5.3)

.. |license| image:: https://img.shields.io/pypi/l/Function-Limiter.svg?style=flat
    :target: https://pypi.python.org/pypi/Function-Limiter


*****************
Function-Limiter
*****************
|license|


Function-Limiter provides rate limiting features to callable function.

Quickstart
===========

Add the rate limiter to your function as decorator. The following example uses the default
in memory implementation for storage.


.. code:: python

    from function_limiter.limiter import Limiter
    from function_limiter.limiter import RateLimitExceeded
    import time

    limiter = Limiter()


    @limiter.limit('3/second', 'key')
    def function():
        print('hello world!')


    for i in range(5):
        function()
        time.sleep(1)

    for i in range(5):
        function()
        time.sleep(0.9)

.. :changelog:

Changelog
=========

v0.0.8.1
--------
Release Date: 2021-01-19
    * Bug Fixed.

v0.0.8
------
Release Date: 2021-01-17
    * Bug Fixed.

v0.0.7
------
Release Date: 2021-01-17
    * Bug Fixed.

v0.0.6
------
Release Date: 2021-01-16
    * Added redis as in memory storage.

v0.0.5
------
Release Date: 2021-01-16
    * Added garbage collector.

v0.0.4
------
Release Date: 2021-01-16
    * Added Validator to limiter.

v0.0.3
------
Release Date: 2021-01-14
    * Added callable function for limitation and key function.

v0.0.2
------
Release Date: 2021-01-14
    * Bug fixed.

v0.0.1
------
Release Date: 2021-01-13
    * Basic Function Limiter.

