Skip to content

docs: add example usage for add_image method #322

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Tejaswi-Bikkavolu wants to merge 2 commits into from
Closed

docs: add example usage for add_image method #322

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1d8c88a
docs: add note about 10,000 results API limit
Tejaswi-Bikkavolu Apr 7, 2025
10c748b
docs: added example for add_image usage in SDK
Tejaswi-Bikkavolu Apr 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
from openfoodfacts import API
Copy link
Copy Markdown
Contributor

@raphael0202 raphael0202 Aug 12, 2025

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).


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

@teolemon teolemon Aug 12, 2025

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")


result = api.add_image(
barcode="1234567890123",
imagefield="front",
imgpath="path/to/your/image.jpg"
)

print(result.status)
4 changes: 4 additions & 0 deletions openfoodfacts/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
from typing import Any, Dict, List, Optional, Tuple, Union, cast

import requests
"""
NOTE: The Open Food Facts API limits queries to 10,000 results by default.
This limitation may affect large data requests and should be considered when querying large datasets.
"""

from .types import APIConfig, APIVersion, Country, Environment, Facet, Flavor, JSONType
from .utils import URLBuilder, http_session
Expand Down