asgi-compression 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

asgi_compression/brotli.py

@@ -16,7 +16,7 @@ def import_brotli() -> None:
         import brotli
     except ImportError as e:
         raise ImportError(
-            "brotli is not installed, run `pip install brotli`]"
+            'brotli is not installed, run `pip install "asgi-compression[br]"`'
         ) from e
 
 

asgi_compression/zstd.py

@@ -15,7 +15,7 @@ def import_zstandard() -> None:
         import zstandard
     except ImportError as e:
         raise ImportError(
-            "zstandard is not installed, run `pip install zstandard`]"
+            'zstandard is not installed, run `pip install "asgi-compression[zstd]"`'
         ) from e
 
 

asgi_compression-0.1.1.dist-info/METADATA

@@ -0,0 +1,182 @@
+Metadata-Version: 2.4
+Name: asgi-compression
+Version: 0.1.1
+Summary: A framework-independent compression middleware for ASGI applications
+Author-email: Serhii Shevchuk <serhii.shevchuk.dev@gmail.com>
+Maintainer-email: Serhii Shevchuk <serhii.shevchuk.dev@gmail.com>
+License: MIT
+Project-URL: Documentation, https://github.com/serozhenka/asgi-compression
+Project-URL: Issues, https://github.com/serozhenka/asgi-compression/issues
+Project-URL: Source, https://github.com/serozhenka/asgi-compression
+Keywords: asgi,compression,middleware,gzip,brotli,zstandard,zstd
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Web Environment
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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: Programming Language :: Python :: Implementation :: CPython
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: multidict>=6.2.0
+Provides-Extra: all
+Requires-Dist: brotli>=1.1.0; extra == "all"
+Requires-Dist: zstandard>=0.23.0; extra == "all"
+Provides-Extra: br
+Requires-Dist: brotli>=1.1.0; extra == "br"
+Provides-Extra: zstd
+Requires-Dist: zstandard>=0.23.0; extra == "zstd"
+Dynamic: license-file
+
+# ASGI Compression
+
+A framework and platform-independent compression middleware for ASGI applications.
+
+## ✨ Features
+
+- 🚀 **Framework Independent** - Works with any ASGI-compatible framework (FastAPI, Starlette, Litestar, Django, Falcon, etc.)
+- 📦 **Multiple Compression Algorithms** - Supports gzip, brotli, and zstandard compression algorithms
+- 🔄 **Content Negotiation** - Automatically selects the best compression algorithm based on the client's Accept-Encoding header
+- 🛠️ **Fully Configurable** - Control minimum size for compression, compression levels, and more
+- 📏 **Minimal Dependencies** - Single external dependency (multidict) apart from optional compression libraries
+- 📝 **Fully Typed** - Complete type annotations for excellent IDE support and code safety
+- 🐍 **Wide Python Support** - Compatible with Python 3.9 to 3.13
+- 🔍 **Streaming Support** - Efficiently compresses both standard and streaming responses
+- 🖥️ **Platform Independent** - Supports macOS, Linux, and Windows.
+
+## 📥 Installation
+
+Install the package with pip:
+
+```bash
+# Basic installation (includes gzip compression)
+pip install asgi-compression
+
+# With gzip and brotli support
+pip install asgi-compression[br]
+
+# With gzip and zstandard support
+pip install asgi-compression[zstd]
+
+# With gzip, brotli and zstandard support
+pip install asgi-compression[all]
+```
+
+## 🚀 Usage
+
+### Basic Example
+
+```python
+from asgi_compression import CompressionMiddleware, GzipAlgorithm
+
+app = ...  # Your ASGI application
+
+# Apply gzip compression with default settings
+app = CompressionMiddleware(
+    app=app,
+    algorithms=[GzipAlgorithm()],
+)
+```
+
+### Multiple Algorithms Example
+
+```python
+from asgi_compression import (
+    BrotliAlgorithm, 
+    CompressionMiddleware, 
+    GzipAlgorithm, 
+    ZstdAlgorithm
+)
+
+app = ...  # Your ASGI application
+
+# Apply multiple compression algorithms in order of preference
+app = CompressionMiddleware(
+    app=app,
+    algorithms=[
+        BrotliAlgorithm(),  # Brotli will be used if the client supports it
+        ZstdAlgorithm(),    # Zstandard will be used as a fallback
+        GzipAlgorithm(),    # Gzip as a last resort
+    ],
+    minimum_size=1000,      # Only compress responses larger than 1KB
+)
+```
+
+### Framework-Specific Examples
+
+#### FastAPI
+
+```python
+from fastapi import FastAPI
+from asgi_compression import CompressionMiddleware, GzipAlgorithm, BrotliAlgorithm
+
+app = FastAPI()
+
+@app.get("/")
+async def read_root():
+    return {"Hello": "World"}
+
+# Apply compression middleware
+app.add_middleware(
+    CompressionMiddleware,
+    algorithms=[BrotliAlgorithm(), GzipAlgorithm()],
+)
+```
+
+#### Starlette
+
+```python
+from starlette.applications import Starlette
+from starlette.responses import JSONResponse
+from starlette.routing import Route
+from asgi_compression import CompressionMiddleware, GzipAlgorithm
+
+async def homepage(request):
+    return JSONResponse({"hello": "world"})
+
+routes = [
+    Route("/", homepage)
+]
+
+app = Starlette(routes=routes)
+app = CompressionMiddleware(app=app, algorithms=[GzipAlgorithm()])
+```
+
+#### Litestar
+
+```python
+from litestar import Litestar, get
+from asgi_compression import CompressionMiddleware, BrotliAlgorithm
+
+@get("/")
+async def homepage() -> dict:
+    return {"hello": "world"}
+
+app = Litestar(route_handlers=[homepage])
+app = CompressionMiddleware(app=app, algorithms=[BrotliAlgorithm()])
+```
+
+## 🙌 Inspired by
+
+This project was brought to life thanks to inspiration from:
+
+- [Startlette's](https://github.com/encode/starlette) Gzip middleware
+- [brotli-asgi](https://github.com/fullonic/brotli-asgi)
+- [zstd-asgi](https://github.com/tuffnatty/zstd-asgi)
+
+Cudos to devs & maintainers of those amazing libraries!
+
+## 📜 License
+
+This project is licensed under the terms of the MIT license.

asgi_compression-0.1.1.dist-info/RECORD

@@ -0,0 +1,14 @@
+asgi_compression/__init__.py,sha256=hp71J4CeuSECF52-hVS-mia_m0zcXlHV72qABNww_yY,457
+asgi_compression/base.py,sha256=SmWJFT1Iy5I6Sa4_Vp2uMIr4iaQE6iq686havVoZPmQ,5145
+asgi_compression/brotli.py,sha256=hH9SgvxlXxZQN6Cz8VZfqktGU2qhmOPa09KkzdSwti0,2648
+asgi_compression/gzip.py,sha256=dj7kaH5_VbElH2U88oKVcNQPqKTgXl2lE6ghH5Qo0CU,1608
+asgi_compression/identity.py,sha256=tIGUAXxA6YJS0KsZO8se4dlR1_q6_YJNXIBU06-AE98,692
+asgi_compression/middleware.py,sha256=bbH_bdsB3MSgdSN3qMj2VjkGqeGiBGBQRclEsQ6dFHo,2737
+asgi_compression/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+asgi_compression/types.py,sha256=QozTp5Ebehh-I-tv_DkZnjQJ0Z91_Mk5W8-rBI4E0rE,2087
+asgi_compression/zstd.py,sha256=vY4W2RSutzDT6Ua-qEtpzXkxj_SypWlV2dPTBNeaesk,2532
+asgi_compression-0.1.1.dist-info/licenses/LICENSE,sha256=At8Q6pgkvQSKYavwqV4PkaC2Y8AWRQdErZm8gYEJzXw,1082
+asgi_compression-0.1.1.dist-info/METADATA,sha256=szhJfzoBSsJGMSC4kopl7NRmgBBeKQDo_Na3_777X_c,5594
+asgi_compression-0.1.1.dist-info/WHEEL,sha256=pxyMxgL8-pra_rKaQ4drOZAegBVuX-G_4nRHjjgWbmo,91
+asgi_compression-0.1.1.dist-info/top_level.txt,sha256=ReOgAA8xTuoMxA4oROBnjJb7yoIjMe7xAB9dz_eXU0Q,17
+asgi_compression-0.1.1.dist-info/RECORD,,

{asgi_compression-0.1.0.dist-info → asgi_compression-0.1.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (78.1.1)
+Generator: setuptools (79.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

asgi_compression-0.1.1.dist-info/licenses/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Serhii Shevchuk
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

asgi_compression-0.1.0.dist-info/METADATA

@@ -1,14 +0,0 @@
-Metadata-Version: 2.4
-Name: asgi-compression
-Version: 0.1.0
-Summary: Add your description here
-Requires-Python: >=3.9
-Description-Content-Type: text/markdown
-Requires-Dist: multidict>=6.2.0
-Provides-Extra: all
-Requires-Dist: brotli>=1.1.0; extra == "all"
-Requires-Dist: zstandard>=0.23.0; extra == "all"
-Provides-Extra: br
-Requires-Dist: brotli>=1.1.0; extra == "br"
-Provides-Extra: zstd
-Requires-Dist: zstandard>=0.23.0; extra == "zstd"

asgi_compression-0.1.0.dist-info/RECORD

@@ -1,12 +0,0 @@
-asgi_compression/__init__.py,sha256=hp71J4CeuSECF52-hVS-mia_m0zcXlHV72qABNww_yY,457
-asgi_compression/base.py,sha256=SmWJFT1Iy5I6Sa4_Vp2uMIr4iaQE6iq686havVoZPmQ,5145
-asgi_compression/brotli.py,sha256=e2YHx1anKJkvHgw0OoDJK_adzZ1ZKLwdrPgDjkUmoQU,2633
-asgi_compression/gzip.py,sha256=dj7kaH5_VbElH2U88oKVcNQPqKTgXl2lE6ghH5Qo0CU,1608
-asgi_compression/identity.py,sha256=tIGUAXxA6YJS0KsZO8se4dlR1_q6_YJNXIBU06-AE98,692
-asgi_compression/middleware.py,sha256=bbH_bdsB3MSgdSN3qMj2VjkGqeGiBGBQRclEsQ6dFHo,2737
-asgi_compression/types.py,sha256=QozTp5Ebehh-I-tv_DkZnjQJ0Z91_Mk5W8-rBI4E0rE,2087
-asgi_compression/zstd.py,sha256=HYX80EzHKy38w5ygAeEcR4Y8a4KVi1UNyns63ziAuvc,2518
-asgi_compression-0.1.0.dist-info/METADATA,sha256=DhbHj5rGQfMI4olwnY3vtrIuJSYq5SyXohPztAf51MI,438
-asgi_compression-0.1.0.dist-info/WHEEL,sha256=lTU6B6eIfYoiQJTZNc-fyaR6BpL6ehTzU3xGYxn2n8k,91
-asgi_compression-0.1.0.dist-info/top_level.txt,sha256=ReOgAA8xTuoMxA4oROBnjJb7yoIjMe7xAB9dz_eXU0Q,17
-asgi_compression-0.1.0.dist-info/RECORD,,