📝 Add framework integration documentation (FastAPI, Starlette, Django)
Open
Nobody has claimed this yet.
area/limiter
documentation
- Dominant language
- Python
- Stars
- 0
- Forks
- 0
- Avg merge
- 6h 51m
- Merged PRs (30d)
- 104
Description
Description
Create comprehensive documentation for integrating zae-limiter with popular Python web frameworks. This documentation should provide ready-to-use patterns that developers can copy and adapt to their applications.
Target Frameworks
- FastAPI - Dependency injection, middleware, exception handlers
- Starlette - Middleware, exception handlers (foundation for FastAPI patterns)
- Django - Middleware, decorator patterns, async views
Acceptance Criteria
-
docs/guide/framework-integration.mdcreated with all three framework examples - FastAPI section includes: dependency injection pattern, middleware example, custom exception handler
- Starlette section includes: middleware example, exception handler
- Django section includes: middleware class, decorator for views, async view example
- All code examples are syntactically valid Python (can be parsed without errors)
- Each framework section includes error handling with
RateLimitExceededreturning HTTP 429 - Each framework section includes
RateLimiterUnavailablehandling with configurable behavior - Examples use
SyncRateLimiterfor sync contexts andRateLimiterfor async contexts -
docs/guide/basic-usage.mdupdated with link to new framework integration page in "Next Steps" section -
mkdocs.ymlupdated to include new page in nav under User Guide
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing docs/guide/basic-usage.md and mkdocs.yml, then create docs/guide/framework-integration.md with the requested FastAPI, Starlette, and Django patterns. Ensure examples cover the specified limiter types, error handling, and HTTP 429 behavior, are syntactically valid Python, and update the guide link and navigation entry. Done means every acceptance criterion is checked.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- django, fastapi, python
- Domain
- backend, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100