Python package for Open Food Facts
This is the official Python SDK for the Open Food Facts project. It provides a simple interface to the Open Food Facts API and allows you to:
It also provides some helper functions to make it easier to work with Open Food Facts data and APIs, such as:
Please note that this SDK is still in beta and the API is subject to change. Make sure to pin the version in your requirements file.
The easiest way to install the SDK is through pip:
pip install openfoodfacts
or manually from source:
git clone https://github.com/openfoodfacts/openfoodfacts-python
cd openfoodfacts-python
python setup.py install
All the examples below assume that you have imported the SDK and instanciated the API object:
import openfoodfacts
# User-Agent is mandatory
api = openfoodfacts.API(user_agent="MyAwesomeApp/1.0")
Get information about a product
code = "3017620422003"
api.product.get(code, fields=["code", "product_name"])
# {'code': '3017620422003', 'product_name': 'Nutella'}
Perform text search
api.product.text_search("mineral water")
# {"count": 3006628, "page": 1, "page_count": 20, "page_size": 20, "products": [{...}], "skip": 0}
Create a new product or update an existing one
results = api.product.update({
"code": CODE,
"product_name_en": "blueberry jam",
"ingredients_text_en": "blueberries, sugar, pectin, citric acid"
})
with CODE
the product barcode. The rest of the body should be a dictionary of fields to create/update.
To see all possible capabilities, check out the usage guide.
If you use this SDK, feel free to open a PR to add your application in this list.
Any help is welcome, as long as you don't break the continuous integration. Fork the repository and open a Pull Request directly on the "develop" branch. A maintainer will review and integrate your changes.
Maintainers:
Contributors:
Copyright 2016-2024 Open Food Facts
The Open Food Facts Python SDK is licensed under the MIT License.