Open Food Facts Python SDK
Status
Description
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:
- Get information about a product
- Perform text search
- Create a new product or update an existing one
It also provides some helper functions to make it easier to work with Open Food Facts data and APIs, such as:
- getting translation of a taxonomized field in a given language
- downloading and iterating over the Open Food Facts data dump
- handling OCRs of Open Food Facts images generated by Google Cloud Vision
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.
Third party applications
If you use this SDK or want to use this SDK, make sure to read the REUSE and ensure you comply with the OdBL licence, in addition to the licence of this package (MIT). Make sure you at least fill the form, and feel free to open a PR to add your application in this list :-)
Installation
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
pip install . # Note the “.” at the end!
Examples
All the examples below assume that you have imported the SDK and instantiated 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.
Contributing
See CONTRIBUTING.md
Copyright and License
Copyright 2016-2024 Open Food Facts
The Open Food Facts Python SDK is licensed under the MIT License.
Other files that are not part of the SDK itself may be under different a different license. The project complies with the REUSE 3.3 specification, so any such files should be marked accordingly.
3 maintainers
Metadata
3 maintainers
Release files for openfoodfacts 5.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| openfoodfacts-5.4.1.tar.gz | 62.9 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| openfoodfacts-5.4.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 129.2 kB
Release files / openfoodfacts-5.4.1.tar.gz
| Download URL | openfoodfacts-5.4.1.tar.gz |
|---|---|
| Size | 62.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a08e460da64c20db38e06e86d9683bfc2c07285ad087b96013ce794d57baf3f2
|
|
BLAKE2b-256 checksum How to use checksums |
ae9f31e4d2d396dbb3ffb2a9e9fd9d2b03c13ad064621a3e19a26b7ed9ec434d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / openfoodfacts-5.4.1-py3-none-any.whl
| Download URL | openfoodfacts-5.4.1-py3-none-any.whl |
|---|---|
| Size | 66.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8304fd86a7978a517094c25403e0f397b0e2555eaf31f6f60e69fffb89fa30b8
|
|
BLAKE2b-256 checksum How to use checksums |
525aaaccc003ae26092782f9ebe099f0dd73cf1adaf6c24d71f99d888257f3e6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.10.2 {"installer":{"name":"uv","version":"0.10.2","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for openfoodfacts 5.4.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
