intake / intake/python-snappy

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

未关闭 适合新手
#152 3 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Python
星标
490
派生
104
PR 合并指标
30 天内没有已合并 PR

描述

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](https://pypi.org/project/python-snappy/):

> Python bindings for the snappy compression library from Google.
>
> More details about Snappy library: [http://google.github.io/snappy](http://google.github.io/snappy)

Image

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](https://github.com/google/snappy), and packaged as the [`snappy` conda-forge package](https://anaconda.org/channels/conda-forge/packages/snappy/overview) and libsnappy-* apt packages in Ubuntu etc.). But since https://github.com/intake/python-snappy/pull/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.

Image

贡献指南

这个仓库没有索引到贡献指南

调研方向

Start with the README headline and the project metadata that supplies the PyPI description, then verify the distinction between python-snappy's Snappy protocol implementation and the native libsnappy library referenced by the links. Update both descriptions and the README's closing explanation so the dependency and reference relationship is unambiguous.

由索引模型根据 Issue 内容生成。

评估

技术栈
python
领域
documentation
Issue 类型
文档
难度
2/5
预计耗时
1-3 小时
活跃度
冷清
描述清晰度
基本清楚
新手友好度
72/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。