Skip to main content

A fixed window rate limiting based on Redis

Project description

# django-redis-ratelimit

[![Build Status](https://travis-ci.org/r00m/django-redis-ratelimit.svg?branch=master)](https://travis-ci.org/r00m/django-redis-ratelimit)

A fixed window rate limiting based on Redis

---

## Installation

To install django-redis-ratelimit, simply:

```console
$ pip install django-redis-ratelimit
```

**NB!** django-redis-ratelimit requires a running Redis server. See [Redis's quickstart](http://redis.io/topics/quickstart)
for installation instructions.

## Getting started

First, add the middleware to your `settings.py`:

```django
MIDDLEWARE = [
# ...

'redis_ratelimit.middleware.RateLimitMiddleware',
]
```

this will make sure that end user sees the HTTP 429 response.

Next, apply the `ratelimit` decorator to the view:

```django
from django.http import HttpResponse
from redis_ratelimit import ratelimit

@ratelimit(rate='5/m')
def index(request):
return HttpResponse("Hello World!")
```

## Memory requirements

For this example we will assume that each key takes up roughly 250 bytes and each value is 4 bytes:

```
250 + 4 * 1 million unique hits = ~254 Megabytes
```

## Notes

- [Redis Rate Limiting Pattern #2](https://redis.io/commands/INCR#pattern-rate-limiter-2)

## License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-redis-ratelimit-0.1.0.tar.gz (3.3 kB view hashes)

Uploaded Source

Built Distribution

django_redis_ratelimit-0.1.0-py2.py3-none-any.whl (5.9 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page