openfoodfacts 0.3.14+1 openfoodfacts: ^0.3.14+1 copied to clipboard
Dart package for the Open Food Facts API, a food products database made by everyone, for everyone.
Open Food Facts - Dart #
Dart package for the Open Food Facts API. Easily access to more than 1.5 million products from all around the world. Open Food Facts is powered by global contributors and is constantly growing thanks to them.
General principles #
- You can look for information about products, including many useful computed values.
- If you can't get the information on a specific product, you can get your user to send photos and data, that will then be processed by Open Food Facts AI and contributors to get the computed result you want to show them.
- You can also implement the complete flow so that they get immediately the result with some effort on their side.
If your users do expect a result immediately (eg. Inventory apps) #
- Send photos (front/nutrition/ingredients): most painless thing for your users
- The Open Food Facts AI Robotoff will generate some derived data from the photos
- Overtime, other apps, and the Open Food Facts community will fill the data gaps
If your users expect a result immediately: #
- Send nutrition facts + category > get Nutri-Score
- Send ingredients > get the NOVA group (about food ultra-processing), additives, allergens, normalized ingredients, vegan, vegetarian…
- Send category + labels > get soon the Eco-Score (about environmental impact)
Open Data Licence #
The database in under the OdBL. This means attributing the source and also contributing back any additions (photos, data), which this package makes easy to do. You can check the terms of use here : Terms of use.
List of current features #
- ✅ Product: you can retrieve information about products
- ✅ Fetch Product images
- ✅ Send images: that you can do
READ #
- ❌ Product
- ❌ Product images
- ❌ Additives, Allergens, Environnement impact, Ingredient analysis, Nutrient levels
- ❌ Recommanded Daily Intakes
- ❌ Personalized search
- ❌ Product completion status
WRITE #
- ❌ ???
- ❌ Send images
- ❌ User comments and auth
ML #
- ❌ Robotoff support
Other #
Roadmap #
TODO: complete me
READ #
- ❌ ???
WRITE #
- ❌ Nutrition table
- ❌ Ingredient list
- ❌ Multilingual fields
- ❌ Regular fields
- ❌ Photo upload
- ❌ Photo operations (rotate, crop, select, unselect with language awareness)
Other #
Contribute #
There are many ways to contribute, and Open Food Facts has a lot of projects beside this package. Most of our operations are coordinated through our Slack which you can join here : Open Food Facts Slack.
Regarding this package, we accept pull requests as well feature requests.
Testing #
Execute the following command from the root of the repository to run the tests:
flutter test test/
How to use ? #
You can find the full documentation here : Documentation.