🎯 What can I work on ? (Python SDK)

[teolemon]

Simplify developer flow

Beta Give feedback

1. Add automatic release using GitHub Actions #75
   DevOps github_actions +2
2. Generate automated documentation using GitHub Actions #74
   github_actions +1
   
3. Package for Conda #54
   📦 Packaging +1

Add new and missing features

Beta Give feedback

1. Document or Increase the maximum amount of results using facets #69
   API READ Facets documentation +3
2. how to get categories by page #56
   ✨ enhancement +1
3. Document image addition #55
   API WRITE - Photos ✨ enhancement +2
4. Allow to edit a product #10
   API WRITE +1

GENERAL

Beta Give feedback

1. Multilingual (180 languages are supported)
2. Create users
3. Check if users exist

READ

Beta Give feedback

1. Product: you can retrieve information about products
2. Product images (get product image by field, size and language, current fields are: Front, Ingredients, Nutrition, Packaging)
3. Additives, Allergens, Environment impact, Ingredient analysis, Nutrient levels, Nutrition facts (incl. micro-nutrients)
4. Language dependant fields (like ingredients, product name, packaging text)
5. Eco-Score, Nutri-Score, NOVA groups
6. Translated, high-level and customizable product information (Attributes)
7. Product completion status
8. Folksonomy Engine (custom properties for products)
9. Open Food Facts Events (Gamification)

PERSONALIZATION

Beta Give feedback

1. Recommended Daily Intakes
2. Translated, high-level and customizable product information (Attributes)
3. Autocompleting for the user inputs, by giving suggestions for (Labels, categories, ingredients, additives, traces ...)

SEARCH

Beta Give feedback

1. search products by tags
2. search products with / without additives
3. search products with keywords
4. Personalized search
5. Search V2

Search V2 - Tag types

Beta Give feedback

1. tag:brands - possible values: infinite, json taxo but no autosuggest
2. tag:categories - possible values: finite, json taxo + autosuggest + partial taxo API
3. tag:packaging - display:packaging - packaging
4. tag:labels - possible values: finite, json taxo + autosuggest + partial taxo API
5. tag:origins - display:origins of ingredients - origins of ingredients
6. tag:manufacturing_places - display:manufacturing or processing places - manufacturing or processing places
7. tag:emb_codes - display:packager codes - packager codes
8. tag:purchase_places - display:purchase places - purchase places
9. tag:stores - display:stores - stores
10. tag:countries - possible values: finite (190), json taxo + autosuggest + partial taxo API
11. tag:ingredients -possible values: finite, json taxo + autosuggest + partial taxo API
12. tag:additives - possible values: finite, json taxo + autosuggest + partial taxo API
13. tag:allergens - possible values: finite, json taxo + autosuggest + partial taxo API
14. tag:traces - possible values: finite, json taxo + autosuggest + partial taxo API
15. tag:nutrition_grades possible values: finite (a,b,c,d,e) , json taxo + autosuggest + partial taxo API
16. #539
17. tag:languages - possible values: finite, json taxo + autosuggest + partial taxo API
18. tag:creator - possible values: infinite - we can't really suggest anything (or we have to rely on the facet)
19. tag:editors - possible values: infinite - we can't really suggest anything (or we have to rely on the facet)
20. tag:states - possible values: finite, json taxo + autosuggest + partial taxo API

WRITE

Beta Give feedback

1. Save product to Open Food Facts
2. Send images
3. User comments and auth
4. Anonymous photo upload
5. Photo operations (rotate, crop, select, unselect with language awareness)

ML/OCR

Beta Give feedback

1. Get the OCR of the ingredients photo (for validation purposes)
2. Robotoff support
3. Extract ingredients from ingredients image: User can extract the ingredients text if it is missing

Process

• Capture the barcode of the product where you want to perform the OCR.
• The Product Opener server software opens the image (process_image=1)
• Product Opener returns a JSON response. Processing is done using Tesseract or Google Cloud Vision (recommended). The result is often cripped with errors with Tesseract, less with Google Cloud Vision.

Notes:

• The OCR may contain errors. Encourage your users to correct the output using the ingredients WRITE API.
• You can also use your own OCR, especially if to plan to send a high number of queries.

Parameters
Test server: https://world.openfoodfacts.org/cgi/ingredients.pl
code=code
id=imagefield
process_image=1

Roadmap

• List of new APIs to implement: https://github.com/openfoodfacts/api-documentation/issues
• New APIs: https://github.com/openfoodfacts/api-documentation/issues?q=is%3Aissue+is%3Aopen+label%3A%22new+api+to+document%22
• Existing APIs: https://github.com/openfoodfacts/api-documentation/

[Ansh-Sarkar]

Hi ! Is the SDK still being maintained ?

[teolemon]

@Ansh-Sarkar we're trying our best, yes