Open Food Facts官方Python SDK
项目描述
Open Food Facts Python SDK
状态
描述
这是Open Food Facts项目的官方Python SDK。它提供了一个简单的接口来访问Open Food Facts API，并允许您
- 获取产品信息
- 执行文本搜索
- 创建新产品或更新现有产品
它还提供了一些辅助函数，以便更容易地处理Open Food Facts数据和API，例如
- 获取给定语言的分类字段翻译
- 下载并迭代Open Food Facts数据转储
- 处理由Google Cloud Vision生成的Open Food Facts图像的OCR
请注意，此SDK仍处于测试阶段，API可能会更改。请确保在您的需求文件中固定版本。
安装
安装SDK的最简单方法是使用pip
pip install openfoodfacts
或手动从源代码安装
git clone https://github.com/openfoodfacts/openfoodfacts-python
cd openfoodfacts-python
python setup.py install
示例
以下所有示例都假设您已导入SDK并实例化了API对象。
import openfoodfacts
# User-Agent is mandatory
api = openfoodfacts.API(user_agent="MyAwesomeApp/1.0")
获取产品信息
code = "3017620422003"
api.product.get(code, fields=["code", "product_name"])
# {'code': '3017620422003', 'product_name': 'Nutella'}
执行文本搜索
api.product.text_search("mineral water")
# {"count": 3006628, "page": 1, "page_count": 20, "page_size": 20, "products": [{...}], "skip": 0}
创建新产品或更新现有产品
results = api.product.update({
"code": CODE,
"product_name_en": "blueberry jam",
"ingredients_text_en": "blueberries, sugar, pectin, citric acid"
})
使用CODE作为产品条码。其余的身体部分应该是一个字段字典，用于创建/更新。
要查看所有可能的功能，请查看使用指南。
第三方应用程序
如果您使用此SDK，请随时提交一个PR来将您的应用程序添加到此列表中。
贡献
任何帮助都受欢迎，只要您不要破坏持续集成。Fork仓库并在“develop”分支上直接打开一个Pull Request。维护者将审查并整合您的更改。
维护者
贡献者
- Agamit Sudo
- Daniel Stolpe
- Enioluwa Segun
- Nicolas Leger
- Pablo Hinojosa
- Andrea Stagi
- Benoît Prieur
- Aadarsh A
版权和许可
Copyright 2016-2024 Open Food Facts
Open Food Facts Python SDK采用MIT许可证。
下载文件
下载您平台上的文件。如果您不确定选择哪个，请了解更多关于安装软件包的信息。
源分布
openfoodfacts-1.1.3.tar.gz (36.8 kB 查看哈希)
构建分布
openfoodfacts-1.1.3-py3-none-any.whl (38.8 kB 查看哈希)
