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 (180 forks)batch import
help wanted

Repository metrics

Stars
 (904 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Review the existing documentation for customizing get usage and is rate limited, and create examples showing how to use them with decorators and other methods.
Tech stack
python
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Needs investigation
Prerequisites
PythonDjango
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80