README's "for ... library from Google" text could be confusing?

[apjanke]

The python-snappy README and PyPI project description for python-snappy currently say this as their headline:

README:

Python library for the snappy compression library from Google.

PyPI page:

Python bindings for the snappy compression library from Google.

More details about Snappy library: http://google.github.io/snappy

I found this a little confusing when I was trying to figure out python-snappy's dependencies. Especially with the link on the PyPI page going to libsnappy.

python-snappy implements the snappy compression protocol from Google. To me, "the snappy compression library from Google" means the "libsnappy" native/C library Google publishes. (At the google/snappy repo, and packaged as the snappy conda-forge package and libsnappy-* apt packages in Ubuntu etc.). But since #130 and python-snappy 0.7.0 or so in Feb 2024, python-snappy uses cramjam instead of libsnappy. (Right?)

Maybe these should say "Python library for the snappy compression protocol from Google" instead? Or "format"? But not "library".

And maybe this thing at the bottom of the README should clarify that it's being used as a reference for the protocol etc., and the implementation library itself is not a dependency or part of python-snappy.

[martindurant]

Your understanding is right - the text didn't get updated when this library switched to using cramjam. However, that also, effectively, marks this repo's deprecation, since it doesn't really add any extra features. Yes, it would be good to update the text, but not very high priority :)

[apjanke]

Fair enough. :)

Would you consider a little PR to change it if I made one? This repo may be deprecated, but it's still used by pymongo, which has, uhh, at least a few active users. :) That's how I got here in the first place: trying to figure out what exactly pymongo's Snappy-related dependencies are and how I needed to install them.

[martindurant]

Of course, go ahead