Skip to content

docs: add barcode utilities and multi-flavor examples to usage guide #470

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

Open
Pawansingh3889 wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

docs: add barcode utilities and multi-flavor examples to usage guide #470

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
34 changes: 34 additions & 0 deletions docs/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,40 @@ print(results)
# 'vegetarian': 'yes'}]
```

## Barcode utilities

The SDK includes utilities for normalizing and validating barcodes (GTINs):

```python
from openfoodfacts.barcode import normalize_barcode, has_valid_check_digit

# Normalize a barcode (pad to 8 or 13 digits)
normalize_barcode("3017620422003") # '3017620422003'
normalize_barcode("4003") # '00004003' (padded to 8)

# Validate a barcode check digit
has_valid_check_digit("3017620422003") # True
has_valid_check_digit("3017620422004") # False
```

## Working with other Open*Facts projects

The SDK supports all Open*Facts projects, not just food:

```python
from openfoodfacts import API, Flavor

# Open Beauty Facts
beauty_api = API(user_agent="<app>", flavor=Flavor.obf)
product = beauty_api.product.get("3600523577941")

# Open Pet Food Facts
petfood_api = API(user_agent="<app>", flavor=Flavor.opff)

# Open Products Facts
products_api = API(user_agent="<app>", flavor=Flavor.opf)
```

## Using the dataset

If you're planning to perform data analysis on Open Food Facts, the easiest way is to download and use the Open Food Facts dataset dump. Fortunately it can be done really easily using the SDK:
Expand Down
Loading