zeroae / zeroae/zae-limiter

📝 Add framework integration documentation (FastAPI, Starlette, Django)

Open
#258 0 comments 0 reactions 0 assignees View on GitHub

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

  1. FastAPI - Dependency injection, middleware, exception handlers
  2. Starlette - Middleware, exception handlers (foundation for FastAPI patterns)
  3. Django - Middleware, decorator patterns, async views

Acceptance Criteria

  • docs/guide/framework-integration.md created 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 RateLimitExceeded returning HTTP 429
  • Each framework section includes RateLimiterUnavailable handling with configurable behavior
  • Examples use SyncRateLimiter for sync contexts and RateLimiter for async contexts
  • docs/guide/basic-usage.md updated with link to new framework integration page in "Next Steps" section
  • mkdocs.yml updated to include new page in nav under User Guide

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.