pycurb 0.1.0__tar.gz

pycurb-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pycurb-0.1.0/PKG-INFO

@@ -0,0 +1,256 @@
+Metadata-Version: 2.4
+Name: pycurb
+Version: 0.1.0
+Summary: A framework-agnostic Python rate limit library
+Author-email: Oluwaseun Ogunsanu <ogunsanu17@gmail.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/fore-site/pycurb
+Project-URL: Repository, https://github.com/fore-site/pycurb
+Project-URL: Documentation, https://pycurb.readthedocs.io/
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic>=2.13.4
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.137.0; extra == "fastapi"
+Requires-Dist: starlette>=1.0.0; extra == "fastapi"
+Provides-Extra: django
+Requires-Dist: django>=5.2.15; extra == "django"
+Provides-Extra: flask
+Requires-Dist: flask>=3.0.0; extra == "flask"
+Requires-Dist: flask-login>=0.6.3; extra == "flask"
+Provides-Extra: redis
+Requires-Dist: redis>=8.0.0; extra == "redis"
+Provides-Extra: all
+Requires-Dist: pycurb[redis]; extra == "all"
+Requires-Dist: pycurb[fastapi]; extra == "all"
+Requires-Dist: pycurb[django]; extra == "all"
+Requires-Dist: pycurb[flask]; extra == "all"
+Provides-Extra: docs
+Requires-Dist: mkdocs>=1.6.1; extra == "docs"
+Requires-Dist: mkdocs-git-revision-date-localized-plugin>=1.5.3; extra == "docs"
+Requires-Dist: mkdocs-material>=9.7.6; extra == "docs"
+Requires-Dist: mkdocstrings-python>=2.0.5; extra == "docs"
+Requires-Dist: mkdocstrings-python-xref>=2.1.1; extra == "docs"
+Requires-Dist: ruff>=0.15.18; extra == "docs"
+Dynamic: license-file
+
+# PyCurb – A Framework‑Agnostic Rate Limiter for Python
+
+[![CI](https://github.com/fore-site/pycurb/actions/workflows/test.yml/badge.svg)](https://github.com/fore-site/pycurb/actions)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+[![Documentation Status](https://readthedocs.org/projects/pycurb/badge/?version=latest)](https://pycurb.readthedocs.io/en/latest/?badge=latest)
+
+**PyCurb** is a flexible, and easy‑to‑use rate‑limiting library for Python. It is desgined to be **framework‑agnostic**, i.e, used with FastAPI, Flask, Django, or even in plain scripts and CLI tools. It supports multiple algorithms, redis & in-memory storage backends, and has advanced features like composite (multi‑tier) limits, and dynamic rule updates.
+
+## Algorithms
+
+PyCurb implements five industry‑standard rate‑limiting algorithms, each suited for different traffic patterns. Choose the one that best fits your use case.
+
+### 1. Sliding Window
+
+The sliding window algorithm maintains a **queue of request timestamps** for each key. The window slides continuously; old timestamps (older than `now - window`) are discarded. At any moment, the number of requests in the window is the length of the queue.
+
+- **Use case**: APIs where you need strict, real‑time limiting without the burstiness of fixed windows.
+- **Parameters**: `limit` (max requests), `window` (duration in seconds).
+- **Behaviour**: The window moves with every request; no abrupt resets.
+
+**Example**  
+Limit: `100 requests per minute`.  
+At `t=10s`, a request arrives; its timestamp is stored. At `t=75s`, the window covers `[15s, 75s]`; any request older than `15s` is dropped. The count is the number of timestamps in that range.
+
+`count = |{ t ∈ timestamps : t > now - window }|`  
+Allowed if `count < limit`.
+
+### 2. Fixed Window
+
+Fixed window divides time into consecutive, non‑overlapping windows of length `window`. All requests within the same window are counted together. The counter resets at the start of each new window.
+
+- **Use case**: Simple, memory‑efficient limiting for non‑critical APIs.
+- **Parameters**: `limit` (max requests per window), `window` (duration in seconds).
+- **Behaviour**: The counter resets abruptly at window boundaries.
+
+**Example**  
+Limit: `100 requests per minute`, windows start at `0s`, `60s`, `120s`, …  
+At `t=10s`, the counter is in window `[0,60)`. At `t=75s`, a new window `[60,120)` begins and the counter resets to `0`.
+
+`window_start = floor(now / window) * window`  
+`counter` is stored for the current `window_start`.  
+Allowed if `counter < limit`.
+
+### 3. Token Bucket
+
+The token bucket algorithm maintains a **bucket of tokens** that refills at a constant rate. Each request consumes one token. If the bucket has at least one token, the request is allowed; otherwise, it is denied.
+
+- **Use case**: APIs that require a steady average rate with the ability to handle short bursts.
+- **Parameters**: `capacity` (burst size), `refill_rate` (tokens per second).
+- **Behaviour**: Allows bursts up to `capacity`; long‑term average is `refill_rate`.
+
+**Example**  
+Capacity = `10`, refill rate = `2 tokens/sec`.  
+Initially, the bucket has `10` tokens. A client can send `10` requests immediately (burst). After that, the bucket refills at `2 tokens/sec`, so the client can sustain `2` requests per second over time.
+
+`tokens = min(capacity, tokens + (now - last_refill) * refill_rate)`  
+Allowed if `tokens >= 1`; then `tokens -= 1`.
+
+### 4. Leaky Bucket
+
+The leaky bucket algorithm models a **queue** that holds pending requests. Requests leak out of the queue at a constant rate (`leak_rate`). New requests are accepted only if the queue has free capacity.
+
+- **Use case**: Smoothing bursty traffic to a constant output rate (e.g., for database writes or external API calls).
+- **Parameters**: `capacity` (max queue size), `leak_rate` (requests per second).
+- **Behaviour**: Smooths bursts; the output rate is constant.
+
+**Example**  
+Capacity = `5`, leak rate = `1 request/sec`.  
+If `5` requests arrive at once, they fill the queue. They are then processed at `1 request/sec`. A new request arriving while the queue is full is dropped.
+
+`leaked = floor((now - last_leak) * leak_rate)`  
+`queue = max(0, queue - leaked)`  
+Allowed if `queue < capacity`; then `queue += 1`.
+
+### 5. GCRA – Generic Cell Rate Algorithm
+
+GCRA (also known as the **leaky bucket with burst control**) uses a single state variable – the **Theoretical Arrival Time (TAT)** – to enforce both a rate and a burst size. It does not require a queue or background processes.
+
+- **Use case**: High‑precision rate limiting where both burst and average rate must be controlled.
+- **Parameters**: `capacity` (burst size), `refill_rate` (requests per second).
+- **Behaviour**: Similar to token bucket but implemented with a single timestamp, making it extremely efficient.
+
+**Example**  
+Capacity = `10`, rate = `5 req/sec` → interval `T = 0.2s`, burst interval `τ = capacity * T = 2s`.  
+The algorithm allows a request if `TAT ≤ now + τ`. After an allowed request, `TAT = max(TAT, now) + T`. This ensures that the average rate is `5 req/sec` and the burst is at most `10` requests.
+
+`T = 1 / refill_rate`  
+`τ = (capacity - 1) * T` _(using `capacity-1` to match the burst size exactly)_  
+Allowed if `TAT ≤ now + τ`.  
+If allowed: `TAT = max(TAT, now) + T`.
+
+### Comparison Table
+
+| Algorithm      | Burst Tolerance | Memory Usage        | Best For                           |
+| -------------- | --------------- | ------------------- | ---------------------------------- |
+| Sliding Window | Up to limit     | Medium (timestamps) | Precise window limits              |
+| Fixed Window   | Up to limit     | Low (counter)       | Simple, low‑overhead limiting      |
+| Token Bucket   | Configurable    | Low (2 floats)      | Burst‑tolerant APIs                |
+| Leaky Bucket   | None (smooths)  | Low (2 floats)      | Constant‑rate processing           |
+| GCRA           | Configurable    | Low (1 float)       | High‑precision, efficient limiting |
+
+Choose the algorithm that aligns with your traffic pattern and resource constraints. All algorithms are fully configurable via the `LimitRule` model.
+
+---
+
+## Get Started
+
+### Installation
+
+Install the core package:
+
+```
+pip install pycurb
+```
+
+For redis as a storage backend, install:
+
+```
+pip install pycurb[redis]
+```
+
+For framework adapters (i.e Flask, Django, FastAPI), install the extras:
+
+```
+pip install pycurb[fastapi]
+```
+
+To install everything:
+
+```
+pip install pycurb[all]
+```
+
+### Basic Usage (Async)
+
+```
+import asyncio
+import time
+from pycurb.core import AsyncRateLimiter, AsyncMemoryStorage, LimitRule
+```
+
+1. Define a rule: 5 requests per 10 seconds
+
+```
+rule = LimitRule(
+    name="api",
+    algorithm="sliding_window",
+    limit=5,
+    window=10,
+)
+```
+
+2. Set up storage and limiter
+
+```
+storage = AsyncMemoryStorage()
+limiter = AsyncRateLimiter(storage, [rule])
+```
+
+3. Use it in your async function
+
+```
+async def fetch_data(user_id: str):
+result = await limiter.check(user_id, "api")
+if result.allowed:
+    print(f"Allowed – remaining: {result.remaining}")
+else:
+    print(f"Denied – retry after: {result.retry_after}")
+
+asyncio.run(fetch_data("user-123"))
+```
+
+### Basic Usage (Sync)
+
+```
+from pycurb.core import RateLimiter, MemoryStorage, LimitRule
+
+storage = MemoryStorage()
+limiter = RateLimiter(storage, [rule])
+
+def handle_request(user_id: str):
+    result = limiter.check(user_id, "api")
+    if result.allowed:
+        print("Request allowed")
+    else:
+        print(f"Rate limited. Retry after {result.retry_after} seconds.")
+```
+
+### Using the Decorator
+
+The `@rate_limit` decorator wraps any sync or async function
+
+```
+from pycurb.core import rate_limit
+
+@rate_limit(limiter, limit_str="5/10s", key_extractor=lambda user_id: str(user_id))
+async def my_function(user_id: str):
+    return "OK"
+```
+
+### Framework Adapters
+
+Pycurb provides plug-and-play adapters for popular python frameworks
+
+- FastAPI: Use the `RateLimitMiddleware` class or `rate_limiter` dependency
+- Django: Use the `rate_limit` decorator or the `create_rate_limit_middleware` factory
+- Flask: Use the `rate_limit` decorator or the `RateLimit` extension
+
+---
+
+## Links
+
+- [Documentation](https://pycurb.readthedocs.io/en/latest)

pycurb-0.1.0/README.md

@@ -0,0 +1,213 @@
+# PyCurb – A Framework‑Agnostic Rate Limiter for Python
+
+[![CI](https://github.com/fore-site/pycurb/actions/workflows/test.yml/badge.svg)](https://github.com/fore-site/pycurb/actions)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+[![Documentation Status](https://readthedocs.org/projects/pycurb/badge/?version=latest)](https://pycurb.readthedocs.io/en/latest/?badge=latest)
+
+**PyCurb** is a flexible, and easy‑to‑use rate‑limiting library for Python. It is desgined to be **framework‑agnostic**, i.e, used with FastAPI, Flask, Django, or even in plain scripts and CLI tools. It supports multiple algorithms, redis & in-memory storage backends, and has advanced features like composite (multi‑tier) limits, and dynamic rule updates.
+
+## Algorithms
+
+PyCurb implements five industry‑standard rate‑limiting algorithms, each suited for different traffic patterns. Choose the one that best fits your use case.
+
+### 1. Sliding Window
+
+The sliding window algorithm maintains a **queue of request timestamps** for each key. The window slides continuously; old timestamps (older than `now - window`) are discarded. At any moment, the number of requests in the window is the length of the queue.
+
+- **Use case**: APIs where you need strict, real‑time limiting without the burstiness of fixed windows.
+- **Parameters**: `limit` (max requests), `window` (duration in seconds).
+- **Behaviour**: The window moves with every request; no abrupt resets.
+
+**Example**  
+Limit: `100 requests per minute`.  
+At `t=10s`, a request arrives; its timestamp is stored. At `t=75s`, the window covers `[15s, 75s]`; any request older than `15s` is dropped. The count is the number of timestamps in that range.
+
+`count = |{ t ∈ timestamps : t > now - window }|`  
+Allowed if `count < limit`.
+
+### 2. Fixed Window
+
+Fixed window divides time into consecutive, non‑overlapping windows of length `window`. All requests within the same window are counted together. The counter resets at the start of each new window.
+
+- **Use case**: Simple, memory‑efficient limiting for non‑critical APIs.
+- **Parameters**: `limit` (max requests per window), `window` (duration in seconds).
+- **Behaviour**: The counter resets abruptly at window boundaries.
+
+**Example**  
+Limit: `100 requests per minute`, windows start at `0s`, `60s`, `120s`, …  
+At `t=10s`, the counter is in window `[0,60)`. At `t=75s`, a new window `[60,120)` begins and the counter resets to `0`.
+
+`window_start = floor(now / window) * window`  
+`counter` is stored for the current `window_start`.  
+Allowed if `counter < limit`.
+
+### 3. Token Bucket
+
+The token bucket algorithm maintains a **bucket of tokens** that refills at a constant rate. Each request consumes one token. If the bucket has at least one token, the request is allowed; otherwise, it is denied.
+
+- **Use case**: APIs that require a steady average rate with the ability to handle short bursts.
+- **Parameters**: `capacity` (burst size), `refill_rate` (tokens per second).
+- **Behaviour**: Allows bursts up to `capacity`; long‑term average is `refill_rate`.
+
+**Example**  
+Capacity = `10`, refill rate = `2 tokens/sec`.  
+Initially, the bucket has `10` tokens. A client can send `10` requests immediately (burst). After that, the bucket refills at `2 tokens/sec`, so the client can sustain `2` requests per second over time.
+
+`tokens = min(capacity, tokens + (now - last_refill) * refill_rate)`  
+Allowed if `tokens >= 1`; then `tokens -= 1`.
+
+### 4. Leaky Bucket
+
+The leaky bucket algorithm models a **queue** that holds pending requests. Requests leak out of the queue at a constant rate (`leak_rate`). New requests are accepted only if the queue has free capacity.
+
+- **Use case**: Smoothing bursty traffic to a constant output rate (e.g., for database writes or external API calls).
+- **Parameters**: `capacity` (max queue size), `leak_rate` (requests per second).
+- **Behaviour**: Smooths bursts; the output rate is constant.
+
+**Example**  
+Capacity = `5`, leak rate = `1 request/sec`.  
+If `5` requests arrive at once, they fill the queue. They are then processed at `1 request/sec`. A new request arriving while the queue is full is dropped.
+
+`leaked = floor((now - last_leak) * leak_rate)`  
+`queue = max(0, queue - leaked)`  
+Allowed if `queue < capacity`; then `queue += 1`.
+
+### 5. GCRA – Generic Cell Rate Algorithm
+
+GCRA (also known as the **leaky bucket with burst control**) uses a single state variable – the **Theoretical Arrival Time (TAT)** – to enforce both a rate and a burst size. It does not require a queue or background processes.
+
+- **Use case**: High‑precision rate limiting where both burst and average rate must be controlled.
+- **Parameters**: `capacity` (burst size), `refill_rate` (requests per second).
+- **Behaviour**: Similar to token bucket but implemented with a single timestamp, making it extremely efficient.
+
+**Example**  
+Capacity = `10`, rate = `5 req/sec` → interval `T = 0.2s`, burst interval `τ = capacity * T = 2s`.  
+The algorithm allows a request if `TAT ≤ now + τ`. After an allowed request, `TAT = max(TAT, now) + T`. This ensures that the average rate is `5 req/sec` and the burst is at most `10` requests.
+
+`T = 1 / refill_rate`  
+`τ = (capacity - 1) * T` _(using `capacity-1` to match the burst size exactly)_  
+Allowed if `TAT ≤ now + τ`.  
+If allowed: `TAT = max(TAT, now) + T`.
+
+### Comparison Table
+
+| Algorithm      | Burst Tolerance | Memory Usage        | Best For                           |
+| -------------- | --------------- | ------------------- | ---------------------------------- |
+| Sliding Window | Up to limit     | Medium (timestamps) | Precise window limits              |
+| Fixed Window   | Up to limit     | Low (counter)       | Simple, low‑overhead limiting      |
+| Token Bucket   | Configurable    | Low (2 floats)      | Burst‑tolerant APIs                |
+| Leaky Bucket   | None (smooths)  | Low (2 floats)      | Constant‑rate processing           |
+| GCRA           | Configurable    | Low (1 float)       | High‑precision, efficient limiting |
+
+Choose the algorithm that aligns with your traffic pattern and resource constraints. All algorithms are fully configurable via the `LimitRule` model.
+
+---
+
+## Get Started
+
+### Installation
+
+Install the core package:
+
+```
+pip install pycurb
+```
+
+For redis as a storage backend, install:
+
+```
+pip install pycurb[redis]
+```
+
+For framework adapters (i.e Flask, Django, FastAPI), install the extras:
+
+```
+pip install pycurb[fastapi]
+```
+
+To install everything:
+
+```
+pip install pycurb[all]
+```
+
+### Basic Usage (Async)
+
+```
+import asyncio
+import time
+from pycurb.core import AsyncRateLimiter, AsyncMemoryStorage, LimitRule
+```
+
+1. Define a rule: 5 requests per 10 seconds
+
+```
+rule = LimitRule(
+    name="api",
+    algorithm="sliding_window",
+    limit=5,
+    window=10,
+)
+```
+
+2. Set up storage and limiter
+
+```
+storage = AsyncMemoryStorage()
+limiter = AsyncRateLimiter(storage, [rule])
+```
+
+3. Use it in your async function
+
+```
+async def fetch_data(user_id: str):
+result = await limiter.check(user_id, "api")
+if result.allowed:
+    print(f"Allowed – remaining: {result.remaining}")
+else:
+    print(f"Denied – retry after: {result.retry_after}")
+
+asyncio.run(fetch_data("user-123"))
+```
+
+### Basic Usage (Sync)
+
+```
+from pycurb.core import RateLimiter, MemoryStorage, LimitRule
+
+storage = MemoryStorage()
+limiter = RateLimiter(storage, [rule])
+
+def handle_request(user_id: str):
+    result = limiter.check(user_id, "api")
+    if result.allowed:
+        print("Request allowed")
+    else:
+        print(f"Rate limited. Retry after {result.retry_after} seconds.")
+```
+
+### Using the Decorator
+
+The `@rate_limit` decorator wraps any sync or async function
+
+```
+from pycurb.core import rate_limit
+
+@rate_limit(limiter, limit_str="5/10s", key_extractor=lambda user_id: str(user_id))
+async def my_function(user_id: str):
+    return "OK"
+```
+
+### Framework Adapters
+
+Pycurb provides plug-and-play adapters for popular python frameworks
+
+- FastAPI: Use the `RateLimitMiddleware` class or `rate_limiter` dependency
+- Django: Use the `rate_limit` decorator or the `create_rate_limit_middleware` factory
+- Flask: Use the `rate_limit` decorator or the `RateLimit` extension
+
+---
+
+## Links
+
+- [Documentation](https://pycurb.readthedocs.io/en/latest)