Skip to content

docs: add example usage for add_image method#322

Closed
Tejaswi-Bikkavolu wants to merge 2 commits intoopenfoodfacts:developfrom
Tejaswi-Bikkavolu:docs/image-upload-example
Closed

docs: add example usage for add_image method#322
Tejaswi-Bikkavolu wants to merge 2 commits intoopenfoodfacts:developfrom
Tejaswi-Bikkavolu:docs/image-upload-example

Conversation

@Tejaswi-Bikkavolu
Copy link
Copy Markdown

📄 Added example documentation for the add_image() method in the Open Food Facts Python SDK.

The example includes:

  • How to authenticate using API
  • Parameters for barcode, imagefield, and imgpath
  • Clarifies usage with placeholder values

This will help new contributors and developers understand how to use this method effectively. 😄

Fixes #69 ← (If you commented on an issue earlier, add that number here)

@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Apr 7, 2025

Comment thread docs/source/index.rst
@@ -0,0 +1,11 @@
from openfoodfacts import API

api = API(user_id="tejaswibks", password="your_password")
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
api = API(user_id="tejaswibks", password="your_password")
api = API(user_id="your_username", password="your_password")

Comment thread docs/source/index.rst
@@ -0,0 +1,11 @@
from openfoodfacts import API
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you want to add a section about how to add an image, you should add it to a markdown file (here usage.md would be appropriate).

@github-project-automation github-project-automation Bot moved this from In progress to Review in progress in 🐍 Python SDK - Keep on par with the API Aug 12, 2025
@teolemon teolemon moved this from Todo to In Progress in 🧃🛠️ Open Food Facts SDK tracking Aug 14, 2025
@github-project-automation github-project-automation Bot moved this from Review in progress to Done in 🐍 Python SDK - Keep on par with the API Feb 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

Document or Increase the maximum amount of results using facets

4 participants