jsocol/django-ratelimit

Documentation for custom get_usage / is_rate_limited needed.

Open

#309 opened on Nov 13, 2023

View on GitHub
 (1 comment) (1 reaction) (0 assignees)Python (904 stars) (180 forks)batch import
help wanted

Description

I am looking to do some conditional rate limiting , and I see the documentation about customizing get_usage and is_ratelimited. It' not clear how to use these methods after customization. Do you still call them using the decorator? Are there any examples?

Contributor guide

Tech stack
python
Domain
backendsecurity
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
djangodjango ratelimitrate limiting basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review the source code in django ratelimit for the get usage and is rate limited methods, likely in the decorators module. Check existing documentation and any comments in the code. Provide clear examples of how to override these methods and use them with the decorator, including how to call them after customization. Consider adding a section to the README or a separate docs file.