Open Food Facts Python SDK
What is Open Food Facts?
A food products database
Open Food Facts is a database of food products with ingredients, allergens, nutrition facts and all the tidbits of information we can find on product labels.
Made by everyone
Open Food Facts is a non-profit association of volunteers. 25000+ contributors like you have added 2.5 million+ products from 150 countries using our Android, iPhone or Windows Phone app or their camera to scan barcodes and upload pictures of products and their labels.
For everyone
Data about food is of public interest and has to be open. The complete database is published as open data and can be reused by anyone and for any use. Check-out the cool reuses or make your own!
The Open Food Facts Website: https://world.openfoodfacts.org
Status
Contributing
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:
- Agamit Sudo
- Daniel Stolpe
- Enioluwa Segun
- Nicolas Leger
- Pablo Hinojosa
- Andrea Stagi
- Benoît Prieur
- Aadarsh A
Copyright and License
Copyright 2016-2022 Open Food Facts
The Open Food Facts Python SDK is licensed under the MIT License.
Installation
pip install openfoodfacts
or:
git clone https://github.com/openfoodfacts/openfoodfacts-python
cd openfoodfacts-python
sudo python setup.py install
Examples
- Query a facet
brands = openfoodfacts.facets.get_brands()
- Basic search
search_result = openfoodfacts.products.search(query)
- Add a new product
status_code = openfoodfacts.products.add_new_product({
'code': barcode,
'user_id' : myUsername,
'password' : myPassword,
'product_name' : myProduct,
'stores' : store,
'brands': brand,
'packaging': packaging
})
To see all possible capabilities, check out the usage guide.
Third party applications
If you use this SDK, feel free to open a PR to add your application in this list.