Installation

RateThrottle requires Python 3.10 or higher.

Basic Installation

Install RateThrottle using pip:

pip install ratethrottle

This installs the core package with in-memory storage support.

RateThrottle offers optional dependencies for specific features:

For distributed rate limiting with Redis:

pip install ratethrottle[redis]

For Flask framework support:

pip install ratethrottle[flask]

For FastAPI and Starlette support:

pip install ratethrottle[fastapi]

For Django framework support:

pip install ratethrottle[django]

To install support for all frameworks and Redis:

pip install ratethrottle[frameworks]

For gRPC protocol support

pip install ratethrottle[grpc]

For GraphQL protocol support

pip install ratethrottle[graphql]

For websocket protocol support

# WebSocket support included by default
pip install ratethrottle

# For specific socket-io or channels support:
pip install ratethrottle[websocket]

Install with support for all protocols

pip install ratethrottle[protocols]

Install with all dependencies

pip install ratethrottle[all]

For development with testing and documentation tools:

pip install ratethrottle[dev]

This includes:

To install the latest development version from GitHub:

git clone https://github.com/MykeChidi/ratethrottle.git
cd ratethrottle
pip install -e .

For development with all dependencies:

pip install -e ".[dev,all]"

Verify your installation:

import ratethrottle
print(ratethrottle.__version__)

Python Version

Python 3.10, 3.11, or 3.12

Operating Systems

Linux, macOS, Windows

Optional Dependencies