farl 0.0.4

A FastAPI rate limiting library.

Farl

A powerful and flexible FastAPI rate limiting library that provides comprehensive rate limiting capabilities for your FastAPI applications.

Features

• Easy Integration: Simple setup with FastAPI applications
• Flexible Configuration: Support for various rate limiting strategies
• Multiple Backends: In-memory and Redis backend support
• Comprehensive Protection: Request rate limiting with customizable rules
• Monitoring: Built-in metrics and logging capabilities
• Dependency Injection: FastAPI-style dependency injection support

Installation

pip install farl

Optional Dependencies

For Redis backend support:

pip install farl[redis]

For development:

pip install farl[dev,tests]

Quick Start

from fastapi import Depends, FastAPI
from pydantic import RedisDsn

from farl import (
    AsyncFarl,
    FarlError,
    farl_exceptions_handler,
    rate_limit,
)


# Using Redis backend
redis_uri = RedisDsn("redis://")  # or "redis://"
farl = AsyncFarl(redis_uri=redis_uri)

app = FastAPI()
app.add_exception_handler(FarlError, farl_exceptions_handler)


@app.get(
    "/",
    dependencies=[
        Depends(
            rate_limit({"amount": 1}),
        )
    ],
)
async def pre_minute_1_request():
    return {"message": "ok"}