aio-libs / aiokafka

asyncio client for kafka
http://aiokafka.readthedocs.io/
Apache License 2.0
1.12k stars 226 forks source link

lz4 compression codec not found even after installing lz4 module #1032

Closed suryaprabhakark closed 1 month ago

suryaprabhakark commented 1 month ago

Hi, Had the issue of missing lz4 compression codec, spent 2 hours trying different things with linux, mac. Atlast realised that cramjam package is missing for the codec to work from code which is throwing error. Either we should add cramjam as dependency or update the ReadMe. If its already mentioned somewhere and I missed it, please point me towards the doc.

aiokafka.errors.UnsupportedCodecError: UnsupportedCodecError: Libraries for lz4 compression codec not found

Thanks

vmaurin commented 1 month ago

There is an helper for that (so you don't have to specify cramjam directly, in case it changes), it is in the documentation https://aiokafka.readthedocs.io/en/stable/#optional-lz4-install

vmaurin commented 1 month ago

The doc is wrong about this though (since it was removed)

aiokafka requires the kafka-python library.

suryaprabhakark commented 1 month ago

Thanks @vmaurin, I didnt realised that there is docs links https://aiokafka.readthedocs.io/. I suggest to have the same wlecome page content in the ReadMe.md, which will help a lot.

suryaprabhakark commented 1 month ago

@vmaurin You can close the issue.

ods commented 1 month ago

Thank you, added the link to the documentation