================
Django Ratelimit
================

Project
=======

**Django Ratelimit** is a ratelimiting decorator for Django views.

.. image:: https://travis-ci.org/jsocol/django-ratelimit.png?branch=master
   :target: https://travis-ci.org/jsocol/django-ratelimit

:Code:          https://github.com/jsocol/django-ratelimit
:License:       Apache Software License
:Issues:        https://github.com/jsocol/django-ratelimit/issues
:Documentation: http://django-ratelimit.readthedocs.org/


Quickstart
==========

Install::

   pip install django-ratelimit


Use as a decorator in ``views.py``::

    from ratelimit.decorators import ratelimit

    @ratelimit()
    def myview(request):
        # ...

    @ratelimit(rate='100/h')
    def secondview(request):
        # ...


.. _PyPI: http://pypi.python.org/pypi/django-ratelimit


Contents
========

.. toctree::
   :maxdepth: 2

   settings
   usage
   contributing


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

