developmentseed / developmentseed/starlette-cramjam

add note about performance

Open
#15 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
20
Forks
5
PR merge metrics
No merged PRs in 30d

Description

> 3. Worse Brotli performance
> As per their own benchmarks, they show that their Brotli implementation is slower than the brotli package. [[ref](https://github.com/developmentseed/starlette-cramjam/tree/main?tab=readme-ov-file#performance)]

ref: https://github.com/stac-utils/stac-fastapi/issues/830

Answer:
Agreed and assumed, performance is not always the main goal. BUT the difference is relatively small, also the size of the result is different and smaller for the cramjam method... which could be faster transfert 🤷

Contributor guide

Open the contributing guide

Research direction

Start with the README's performance section, linked in the issue, and compare its current wording with the referenced Brotli benchmarks. Add a note explaining the relative performance difference and the smaller cramjam result, then verify that the README clearly presents this trade-off.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.