hishel 1.0.0.dev2__tar.gz → 1.1.0__tar.gz

{hishel-1.0.0.dev2 → hishel-1.1.0}/CHANGELOG.md

@@ -2,10 +2,62 @@
 
 All notable changes to this project will be documented in this file.
 
+## 1.1.0 - 2025-10-31
+### ⚙️ Miscellaneous Tasks
+- Add in memory example
+
+### 🐛 Bug Fixes
+- Pass any response with non-expected status code on revalidation to client
+
+### 🚀 Features
+- Allow setting storage base with via `database_path` for sqlite storage
+
+## 1.0.0 - 2025-10-28
+### ⚙️ Miscellaneous Tasks
+- Add examples, improve docs
+
+## 1.0.0b1 - 2025-10-28
+### ♻️ Refactoring
+- Add policies
+
+### ⚙️ Miscellaneous Tasks
+- Improve sans-io diagram colors
+- Add graphql docs
+
+### 🐛 Bug Fixes
+- Body-sensitive responses caching
+- Filter out `Transfer-Encoding` header for asgi responses
+
+### 🚀 Features
+- Add global `use_body_key` setting
+
+## 1.0.0.dev3 - 2025-10-26
+### ♻️ Refactoring
+- Replace pairs with entries, simplify storage API
+- Automatically generate httpx sync integration from async
+
+### ⚙️ Miscellaneous Tasks
+- Simplify metadata docs
+- Add custom integrations docs
+- More robust compressed response caching
+
+### 🐛 Bug Fixes
+- Add missing permissions into `publish.yml`
+- Raise on consumed httpx streams, which we can't store as is (it's already decoded)
+- Fix compressed data caching for requests
+- Handle httpx iterable usage instead of iterator correctly
+- Add date header for proper age calculation
+
+### 🚀 Features
+- Add integrations with fastapi and asgi
+- Add blacksheep integration examples
+- Add logging for asgi
+
 ## 1.0.0.dev2 - 2025-10-21
 ### ⚙️ Miscellaneous Tasks
 - Remove redundant utils and tests
 - Add import without extras check in ci
+- Fix time travel date, explicitly specify the timezone
 
 ### 🐛 Bug Fixes
 - Fix check for storing auth requests

{hishel-1.0.0.dev2 → hishel-1.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hishel
-Version: 1.0.0.dev2
+Version: 1.1.0
 Summary:  Elegant HTTP Caching for Python
 Project-URL: Homepage, https://hishel.com
 Project-URL: Source, https://github.com/karpetrosyan/hishel
@@ -29,6 +29,8 @@ Requires-Dist: typing-extensions>=4.14.1
 Provides-Extra: async
 Requires-Dist: anyio>=4.9.0; extra == 'async'
 Requires-Dist: anysqlite>=0.0.5; extra == 'async'
+Provides-Extra: fastapi
+Requires-Dist: fastapi>=0.119.1; extra == 'fastapi'
 Provides-Extra: httpx
 Requires-Dist: anyio>=4.9.0; extra == 'httpx'
 Requires-Dist: anysqlite>=0.0.5; extra == 'httpx'
@@ -37,6 +39,7 @@ Provides-Extra: requests
 Requires-Dist: requests>=2.32.5; extra == 'requests'
 Description-Content-Type: text/markdown
 
+
 <p align="center">
   <img alt="Hishel Logo" width="350" src="https://raw.githubusercontent.com/karpetrosyan/hishel/master/docs/static/Shelkopryad_350x250_yellow.png#gh-dark-mode-only">
   <img alt="Hishel Logo" width="350" src="https://raw.githubusercontent.com/karpetrosyan/hishel/master/docs/static/Shelkopryad_350x250_black.png#gh-light-mode-only">
@@ -73,14 +76,16 @@ Description-Content-Type: text/markdown
 ## ✨ Features
 
 - 🎯 **RFC 9111 Compliant** - Fully compliant with the latest HTTP caching specification
-- 🔌 **Easy Integration** - Drop-in support for HTTPX and Requests
+- 🔌 **Easy Integration** - Drop-in support for HTTPX, Requests, ASGI, FastAPI, and BlackSheep
 - 💾 **Flexible Storage** - SQLite backend with more coming soon
 - ⚡ **High Performance** - Efficient caching with minimal overhead
 - 🔄 **Async & Sync** - Full support for both synchronous and asynchronous workflows
 - 🎨 **Type Safe** - Fully typed with comprehensive type hints
 - 🧪 **Well Tested** - Extensive test coverage and battle-tested
-- 🎛️ **Configurable** - Fine-grained control over caching behavior
-- 🌐 **Future Ready** - Designed for easy integration with any HTTP client/server
+- 🎛️ **Configurable** - Fine-grained control over caching behavior with flexible policies
+- 💨 **Memory Efficient** - Streaming support prevents loading large payloads into memory
+- 🌐 **Universal** - Works with any ASGI application (Starlette, Litestar, BlackSheep, etc.)
+- 🎯 **GraphQL Support** - Cache GraphQL queries with body-sensitive content caching
 
 ## 📦 Installation
 
@@ -90,19 +95,23 @@ pip install hishel
 
 ### Optional Dependencies
 
-Install with specific HTTP client support:
+Install with specific integration support:
 
 ```bash
 pip install hishel[httpx]      # For HTTPX support
 pip install hishel[requests]   # For Requests support
+pip install hishel[fastapi]    # For FastAPI support (includes ASGI)
 ```
 
-Or install both:
+Or install multiple:
 
 ```bash
-pip install hishel[httpx,requests]
+pip install hishel[httpx,requests,fastapi]
 ```
 
+> [!NOTE]
+> ASGI middleware has no extra dependencies - it's included in the base installation.
+ 
 ## 🚀 Quick Start
 
 ### With HTTPX
@@ -156,23 +165,112 @@ response = session.get("https://api.example.com/data")
 print(response.headers.get("X-Hishel-From-Cache"))  # "True"
 ```
 
+### With ASGI Applications
+
+Add caching middleware to any ASGI application:
+
+```python
+from hishel.asgi import ASGICacheMiddleware
+
+# Wrap your ASGI app
+app = ASGICacheMiddleware(app)
+
+# Or configure with options
+from hishel import AsyncSqliteStorage, CacheOptions, SpecificationPolicy
+
+app = ASGICacheMiddleware(
+    app,
+    storage=AsyncSqliteStorage(),
+    policy=SpecificationPolicy(
+      cache_options=CacheOptions(shared=True)
+    ),
+)
+```
+
+### With FastAPI
+
+Add Cache-Control headers using the `cache()` dependency:
+
+```python
+from fastapi import FastAPI
+from hishel.fastapi import cache
+
+app = FastAPI()
+
+@app.get("/api/data", dependencies=[cache(max_age=300, public=True)])
+async def get_data():
+    # Cache-Control: public, max-age=300
+    return {"data": "cached for 5 minutes"}
+  
+# Optionally wrap with ASGI middleware for local caching according to specified rules
+from hishel.asgi import ASGICacheMiddleware
+from hishel import AsyncSqliteStorage
+
+app = ASGICacheMiddleware(app, storage=AsyncSqliteStorage())
+```
+
+### With BlackSheep
+
+Use BlackSheep's native `cache_control` decorator with Hishel's ASGI middleware:
+
+```python
+from blacksheep import Application, get
+from blacksheep.server.headers.cache import cache_control
+
+app = Application()
+
+@get("/api/data")
+@cache_control(max_age=300, public=True)
+async def get_data():
+    # Cache-Control: public, max-age=300
+    return {"data": "cached for 5 minutes"}
+```
+
 ## 🎛️ Advanced Configuration
 
-### Custom Cache Options
+### Caching Policies
+
+Hishel supports two types of caching policies:
+
+**SpecificationPolicy** - RFC 9111 compliant HTTP caching (default):
 
 ```python
-from hishel import CacheOptions
+from hishel import CacheOptions, SpecificationPolicy
 from hishel.httpx import SyncCacheClient
 
 client = SyncCacheClient(
-    cache_options=CacheOptions(
-        shared=False,                              # Use as private cache (browser-like)
-        supported_methods=["GET", "HEAD", "POST"], # Cache GET, HEAD, and POST
-        allow_stale=True                           # Allow serving stale responses
+    policy=SpecificationPolicy(
+        cache_options=CacheOptions(
+            shared=False,                              # Use as private cache (browser-like)
+            supported_methods=["GET", "HEAD", "POST"], # Cache GET, HEAD, and POST
+            allow_stale=True                           # Allow serving stale responses
+        )
+    )
+)
+```
+
+**FilterPolicy** - Custom filtering logic for fine-grained control:
+
+```python
+from hishel import FilterPolicy, BaseFilter, Request
+from hishel.httpx import AsyncCacheClient
+
+class CacheOnlyAPIRequests(BaseFilter[Request]):
+    def needs_body(self) -> bool:
+        return False
+    
+    def apply(self, item: Request, body: bytes | None) -> bool:
+        return "/api/" in str(item.url)
+
+client = AsyncCacheClient(
+    policy=FilterPolicy(
+        request_filters=[CacheOnlyAPIRequests()]
     )
 )
 ```
 
+[Learn more about policies →](https://hishel.com/dev/policies/)
+
 ### Custom Storage Backend
 
 ```python
@@ -188,6 +286,60 @@ storage = SyncSqliteStorage(
 client = SyncCacheClient(storage=storage)
 ```
 
+### GraphQL and Body-Sensitive Caching
+
+Cache GraphQL queries and other POST requests by including the request body in the cache key.
+
+**Using per-request header:**
+
+```python
+from hishel import FilterPolicy
+from hishel.httpx import SyncCacheClient
+
+client = SyncCacheClient(
+    policy=FilterPolicy()
+)
+
+# Cache GraphQL queries - different queries get different cache entries
+graphql_query = """
+    query GetUser($id: ID!) {
+        user(id: $id) {
+            name
+            email
+        }
+    }
+"""
+
+response = client.post(
+    "https://api.example.com/graphql",
+    json={"query": graphql_query, "variables": {"id": "123"}},
+    headers={"X-Hishel-Body-Key": "true"}  # Enable body-based caching
+)
+
+# Different query will be cached separately
+response = client.post(
+    "https://api.example.com/graphql",
+    json={"query": graphql_query, "variables": {"id": "456"}},
+    headers={"X-Hishel-Body-Key": "true"}
+)
+```
+
+**Using global configuration:**
+
+```python
+from hishel.httpx import SyncCacheClient
+from hishel import FilterPolicy
+
+# Enable body-based caching for all requests
+client = SyncCacheClient(policy=FilterPolicy(use_body_key=True))
+
+# All POST requests automatically include body in cache key
+response = client.post(
+    "https://api.example.com/graphql",
+    json={"query": graphql_query, "variables": {"id": "123"}}
+)
+```
+
 ## 🏗️ Architecture
 
 Hishel uses a **sans-I/O state machine** architecture that separates HTTP caching logic from I/O operations:
@@ -199,13 +351,11 @@ Hishel uses a **sans-I/O state machine** architecture that separates HTTP cachin
 
 ## 🔮 Roadmap
 
-While Hishel currently supports HTTPX and Requests, we're actively working on:
+We're actively working on:
 
-- 🎯 Additional HTTP client integrations
-- 🎯 Server-side caching support
-- 🎯 More storage backends
-- 🎯 Advanced caching strategies
 - 🎯 Performance optimizations
+- 🎯 More integrations
+- 🎯 Partial responses support
 
 ## 📚 Documentation
 
@@ -214,7 +364,12 @@ Comprehensive documentation is available at [https://hishel.com/dev](https://his
 - [Getting Started](https://hishel.com)
 - [HTTPX Integration](https://hishel.com/dev/integrations/httpx)
 - [Requests Integration](https://hishel.com/dev/integrations/requests)
+- [ASGI Integration](https://hishel.com/dev/asgi)
+- [FastAPI Integration](https://hishel.com/dev/fastapi)
+- [BlackSheep Integration](https://hishel.com/dev/integrations/blacksheep)
+- [GraphQL Integration](https://hishel.com/dev/integrations/graphql)
 - [Storage Backends](https://hishel.com/dev/storages)
+- [Request/Response Metadata](https://hishel.com/dev/metadata)
 - [RFC 9111 Specification](https://hishel.com/dev/specification)
 
 ## 🤝 Contributing
@@ -255,10 +410,62 @@ Hishel is inspired by and builds upon the excellent work in the Python HTTP ecos
 
 All notable changes to this project will be documented in this file.
 
+## 1.1.0 - 2025-10-31
+### ⚙️ Miscellaneous Tasks
+- Add in memory example
+
+### 🐛 Bug Fixes
+- Pass any response with non-expected status code on revalidation to client
+
+### 🚀 Features
+- Allow setting storage base with via `database_path` for sqlite storage
+
+## 1.0.0 - 2025-10-28
+### ⚙️ Miscellaneous Tasks
+- Add examples, improve docs
+
+## 1.0.0b1 - 2025-10-28
+### ♻️ Refactoring
+- Add policies
+
+### ⚙️ Miscellaneous Tasks
+- Improve sans-io diagram colors
+- Add graphql docs
+
+### 🐛 Bug Fixes
+- Body-sensitive responses caching
+- Filter out `Transfer-Encoding` header for asgi responses
+
+### 🚀 Features
+- Add global `use_body_key` setting
+
+## 1.0.0.dev3 - 2025-10-26
+### ♻️ Refactoring
+- Replace pairs with entries, simplify storage API
+- Automatically generate httpx sync integration from async
+
+### ⚙️ Miscellaneous Tasks
+- Simplify metadata docs
+- Add custom integrations docs
+- More robust compressed response caching
+
+### 🐛 Bug Fixes
+- Add missing permissions into `publish.yml`
+- Raise on consumed httpx streams, which we can't store as is (it's already decoded)
+- Fix compressed data caching for requests
+- Handle httpx iterable usage instead of iterator correctly
+- Add date header for proper age calculation
+
+### 🚀 Features
+- Add integrations with fastapi and asgi
+- Add blacksheep integration examples
+- Add logging for asgi
+
 ## 1.0.0.dev2 - 2025-10-21
 ### ⚙️ Miscellaneous Tasks
 - Remove redundant utils and tests
 - Add import without extras check in ci
+- Fix time travel date, explicitly specify the timezone
 
 ### 🐛 Bug Fixes
 - Fix check for storing auth requests

{hishel-1.0.0.dev2 → hishel-1.1.0}/README.md

@@ -1,3 +1,4 @@
+
 <p align="center">
   <img alt="Hishel Logo" width="350" src="https://raw.githubusercontent.com/karpetrosyan/hishel/master/docs/static/Shelkopryad_350x250_yellow.png#gh-dark-mode-only">
   <img alt="Hishel Logo" width="350" src="https://raw.githubusercontent.com/karpetrosyan/hishel/master/docs/static/Shelkopryad_350x250_black.png#gh-light-mode-only">
@@ -34,14 +35,16 @@
 ## ✨ Features
 
 - 🎯 **RFC 9111 Compliant** - Fully compliant with the latest HTTP caching specification
-- 🔌 **Easy Integration** - Drop-in support for HTTPX and Requests
+- 🔌 **Easy Integration** - Drop-in support for HTTPX, Requests, ASGI, FastAPI, and BlackSheep
 - 💾 **Flexible Storage** - SQLite backend with more coming soon
 - ⚡ **High Performance** - Efficient caching with minimal overhead
 - 🔄 **Async & Sync** - Full support for both synchronous and asynchronous workflows
 - 🎨 **Type Safe** - Fully typed with comprehensive type hints
 - 🧪 **Well Tested** - Extensive test coverage and battle-tested
-- 🎛️ **Configurable** - Fine-grained control over caching behavior
-- 🌐 **Future Ready** - Designed for easy integration with any HTTP client/server
+- 🎛️ **Configurable** - Fine-grained control over caching behavior with flexible policies
+- 💨 **Memory Efficient** - Streaming support prevents loading large payloads into memory
+- 🌐 **Universal** - Works with any ASGI application (Starlette, Litestar, BlackSheep, etc.)
+- 🎯 **GraphQL Support** - Cache GraphQL queries with body-sensitive content caching
 
 ## 📦 Installation
 
@@ -51,19 +54,23 @@ pip install hishel
 
 ### Optional Dependencies
 
-Install with specific HTTP client support:
+Install with specific integration support:
 
 ```bash
 pip install hishel[httpx]      # For HTTPX support
 pip install hishel[requests]   # For Requests support
+pip install hishel[fastapi]    # For FastAPI support (includes ASGI)
 ```
 
-Or install both:
+Or install multiple:
 
 ```bash
-pip install hishel[httpx,requests]
+pip install hishel[httpx,requests,fastapi]
 ```
 
+> [!NOTE]
+> ASGI middleware has no extra dependencies - it's included in the base installation.
+ 
 ## 🚀 Quick Start
 
 ### With HTTPX
@@ -117,23 +124,112 @@ response = session.get("https://api.example.com/data")
 print(response.headers.get("X-Hishel-From-Cache"))  # "True"
 ```
 
+### With ASGI Applications
+
+Add caching middleware to any ASGI application:
+
+```python
+from hishel.asgi import ASGICacheMiddleware
+
+# Wrap your ASGI app
+app = ASGICacheMiddleware(app)
+
+# Or configure with options
+from hishel import AsyncSqliteStorage, CacheOptions, SpecificationPolicy
+
+app = ASGICacheMiddleware(
+    app,
+    storage=AsyncSqliteStorage(),
+    policy=SpecificationPolicy(
+      cache_options=CacheOptions(shared=True)
+    ),
+)
+```
+
+### With FastAPI
+
+Add Cache-Control headers using the `cache()` dependency:
+
+```python
+from fastapi import FastAPI
+from hishel.fastapi import cache
+
+app = FastAPI()
+
+@app.get("/api/data", dependencies=[cache(max_age=300, public=True)])
+async def get_data():
+    # Cache-Control: public, max-age=300
+    return {"data": "cached for 5 minutes"}
+  
+# Optionally wrap with ASGI middleware for local caching according to specified rules
+from hishel.asgi import ASGICacheMiddleware
+from hishel import AsyncSqliteStorage
+
+app = ASGICacheMiddleware(app, storage=AsyncSqliteStorage())
+```
+
+### With BlackSheep
+
+Use BlackSheep's native `cache_control` decorator with Hishel's ASGI middleware:
+
+```python
+from blacksheep import Application, get
+from blacksheep.server.headers.cache import cache_control
+
+app = Application()
+
+@get("/api/data")
+@cache_control(max_age=300, public=True)
+async def get_data():
+    # Cache-Control: public, max-age=300
+    return {"data": "cached for 5 minutes"}
+```
+
 ## 🎛️ Advanced Configuration
 
-### Custom Cache Options
+### Caching Policies
+
+Hishel supports two types of caching policies:
+
+**SpecificationPolicy** - RFC 9111 compliant HTTP caching (default):
 
 ```python
-from hishel import CacheOptions
+from hishel import CacheOptions, SpecificationPolicy
 from hishel.httpx import SyncCacheClient
 
 client = SyncCacheClient(
-    cache_options=CacheOptions(
-        shared=False,                              # Use as private cache (browser-like)
-        supported_methods=["GET", "HEAD", "POST"], # Cache GET, HEAD, and POST
-        allow_stale=True                           # Allow serving stale responses
+    policy=SpecificationPolicy(
+        cache_options=CacheOptions(
+            shared=False,                              # Use as private cache (browser-like)
+            supported_methods=["GET", "HEAD", "POST"], # Cache GET, HEAD, and POST
+            allow_stale=True                           # Allow serving stale responses
+        )
+    )
+)
+```
+
+**FilterPolicy** - Custom filtering logic for fine-grained control:
+
+```python
+from hishel import FilterPolicy, BaseFilter, Request
+from hishel.httpx import AsyncCacheClient
+
+class CacheOnlyAPIRequests(BaseFilter[Request]):
+    def needs_body(self) -> bool:
+        return False
+    
+    def apply(self, item: Request, body: bytes | None) -> bool:
+        return "/api/" in str(item.url)
+
+client = AsyncCacheClient(
+    policy=FilterPolicy(
+        request_filters=[CacheOnlyAPIRequests()]
     )
 )
 ```
 
+[Learn more about policies →](https://hishel.com/dev/policies/)
+
 ### Custom Storage Backend
 
 ```python
@@ -149,6 +245,60 @@ storage = SyncSqliteStorage(
 client = SyncCacheClient(storage=storage)
 ```
 
+### GraphQL and Body-Sensitive Caching
+
+Cache GraphQL queries and other POST requests by including the request body in the cache key.
+
+**Using per-request header:**
+
+```python
+from hishel import FilterPolicy
+from hishel.httpx import SyncCacheClient
+
+client = SyncCacheClient(
+    policy=FilterPolicy()
+)
+
+# Cache GraphQL queries - different queries get different cache entries
+graphql_query = """
+    query GetUser($id: ID!) {
+        user(id: $id) {
+            name
+            email
+        }
+    }
+"""
+
+response = client.post(
+    "https://api.example.com/graphql",
+    json={"query": graphql_query, "variables": {"id": "123"}},
+    headers={"X-Hishel-Body-Key": "true"}  # Enable body-based caching
+)
+
+# Different query will be cached separately
+response = client.post(
+    "https://api.example.com/graphql",
+    json={"query": graphql_query, "variables": {"id": "456"}},
+    headers={"X-Hishel-Body-Key": "true"}
+)
+```
+
+**Using global configuration:**
+
+```python
+from hishel.httpx import SyncCacheClient
+from hishel import FilterPolicy
+
+# Enable body-based caching for all requests
+client = SyncCacheClient(policy=FilterPolicy(use_body_key=True))
+
+# All POST requests automatically include body in cache key
+response = client.post(
+    "https://api.example.com/graphql",
+    json={"query": graphql_query, "variables": {"id": "123"}}
+)
+```
+
 ## 🏗️ Architecture
 
 Hishel uses a **sans-I/O state machine** architecture that separates HTTP caching logic from I/O operations:
@@ -160,13 +310,11 @@ Hishel uses a **sans-I/O state machine** architecture that separates HTTP cachin
 
 ## 🔮 Roadmap
 
-While Hishel currently supports HTTPX and Requests, we're actively working on:
+We're actively working on:
 
-- 🎯 Additional HTTP client integrations
-- 🎯 Server-side caching support
-- 🎯 More storage backends
-- 🎯 Advanced caching strategies
 - 🎯 Performance optimizations
+- 🎯 More integrations
+- 🎯 Partial responses support
 
 ## 📚 Documentation
 
@@ -175,7 +323,12 @@ Comprehensive documentation is available at [https://hishel.com/dev](https://his
 - [Getting Started](https://hishel.com)
 - [HTTPX Integration](https://hishel.com/dev/integrations/httpx)
 - [Requests Integration](https://hishel.com/dev/integrations/requests)
+- [ASGI Integration](https://hishel.com/dev/asgi)
+- [FastAPI Integration](https://hishel.com/dev/fastapi)
+- [BlackSheep Integration](https://hishel.com/dev/integrations/blacksheep)
+- [GraphQL Integration](https://hishel.com/dev/integrations/graphql)
 - [Storage Backends](https://hishel.com/dev/storages)
+- [Request/Response Metadata](https://hishel.com/dev/metadata)
 - [RFC 9111 Specification](https://hishel.com/dev/specification)
 
 ## 🤝 Contributing