Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zaczero/starlette-compress
Compression middleware for Starlette - supporting ZStd, Brotli, and GZip
https://github.com/zaczero/starlette-compress
compression fastapi python starlette starlette-middleware
Last synced: about 1 month ago
JSON representation
Compression middleware for Starlette - supporting ZStd, Brotli, and GZip
- Host: GitHub
- URL: https://github.com/zaczero/starlette-compress
- Owner: Zaczero
- License: unlicense
- Created: 2024-05-07T00:13:26.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-09-15T11:25:39.000Z (about 2 months ago)
- Last Synced: 2024-10-09T23:02:11.019Z (about 1 month ago)
- Topics: compression, fastapi, python, starlette, starlette-middleware
- Language: Python
- Homepage:
- Size: 103 KB
- Stars: 11
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# starlette-compress
[](https://pypi.org/project/starlette-compress)
[](https://liberapay.com/Zaczero/)
[](https://github.com/sponsors/Zaczero)
**starlette-compress** is a fast and simple middleware for compressing responses in [Starlette](https://www.starlette.io). It supports more compression algorithms than Starlette's built-in GZipMiddleware, and has more sensible defaults.
- Python 3.8+ support
- Compatible with `asyncio` and `trio` backends
- ZStd, Brotli, and GZip compression
- Sensible default configuration
- [The Unlicense](https://unlicense.org) — public domain dedication
- [Semantic Versioning](https://semver.org) compliance
## Installation
```sh
pip install starlette-compress
```
## Basic Usage
### Starlette
```py
from starlette.applications import Starlette
from starlette.middleware import Middleware
from starlette_compress import CompressMiddleware
middleware = [
Middleware(CompressMiddleware)
]
app = Starlette(routes=..., middleware=middleware)
```
### FastAPI
You can use starlette-compress with [FastAPI](https://fastapi.tiangolo.com) too:
```py
from fastapi import FastAPI
from starlette_compress import CompressMiddleware
app = FastAPI()
app.add_middleware(CompressMiddleware)
```
## Advanced Usage
### Changing Minimum Response Size
Control the minimum size of the response to compress. By default, responses must be at least 500 bytes to be compressed.
```py
# Starlette
middleware = [
Middleware(CompressMiddleware, minimum_size=1000)
]
# FastAPI
app.add_middleware(CompressMiddleware, minimum_size=1000)
```
### Tuning Compression Levels
Adjust the compression levels for each algorithm. Higher levels mean smaller files but slower compression. Default level is 4 for all algorithms.
```py
# Starlette
middleware = [
Middleware(CompressMiddleware, zstd_level=6, brotli_quality=6, gzip_level=6)
]
# FastAPI
app.add_middleware(CompressMiddleware, zstd_level=6, brotli_quality=6, gzip_level=6)
```
### Supporting Custom Content-Types
Manage the supported content-types. Unknown response types are not compressed. [Check here](https://github.com/Zaczero/starlette-compress/blob/main/starlette_compress/__init__.py) for the default configuration.
```py
from starlette_compress import add_compress_type, remove_compress_type
add_compress_type("application/my-custom-type")
remove_compress_type("application/json")
```