Skip to content

Latest commit

 

History

History
100 lines (68 loc) · 3.66 KB

README.md

File metadata and controls

100 lines (68 loc) · 3.66 KB

Open Food Facts client for your Python applications and scripts

Open Food Facts

What is Open Food Facts?

A food products database

Open Food Facts is a database of food products with ingredients, allergens, nutrition facts and all the tidbits of information we can find on product labels.

Made by everyone

Open Food Facts is a non-profit association of volunteers. 1800+ contributors like you have added 700 000+ products from 150 countries using our Android, iPhone or Windows Phone app or their camera to scan barcodes and upload pictures of products and their labels.

For everyone

Data about food is of public interest and has to be open. The complete database is published as open data and can be reused by anyone and for any use. Check-out the cool reuses or make your own!

Status

Project Status Average time to resolve an issue Percentage of issues still open Build Status codecov Latest Version License: MIT

Contributing

Any help is welcome, as long as you don't break the continuous integration. Fork the repository and open a Pull Request directly on the master branch. A maintainer will review and integrate your changes.

Maintainers:

Contributors:

Copyright and License

Copyright 2016-2020 Open Food Facts

Installation

pip install openfoodfacts

or:

git clone https://github.com/openfoodfacts/openfoodfacts-python
cd openfoodfacts-python
sudo python setup.py install

Docs

Example Usage

Query a Facet

brands = openfoodfacts.facets.get_brands()

Basic Search

search_result = openfoodfacts.products.search(query)

Add a new product.

status_code = openfoodfacts.products.add_new_product({
  'code': barcode,
  'user_id'  : myUsername,
  'password'  : myPassword,
  'product_name' : myProduct,
  'stores'  : store,
  'brands': brand,
  'packaging': packaging
})

To see all possible capabilities, check out the usage guide.