Skip to main content

Official Python SDK of Open Food Facts

Project description

Open Food Facts Python SDK

Open Food Facts

Status

Project Status 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 "develop" branch. A maintainer will review and integrate your changes.

Maintainers:

Contributors:

Copyright and License

Copyright 2016-2022 Open Food Facts

The Open Food Facts Python SDK is licensed under the MIT License.

Installation

The easiest way to install the SDK is through pip:

pip install openfoodfacts

or manually from source:

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

Examples

Get information about a product

api = openfoodfacts.API(version="v2")
code = "3017620422003"
api.product.get(code)

Perform text search

api = openfoodfacts.API(version="v2")
results = api.product.text_search("mineral water")

Create a new product or update an existing one

api = openfoodfacts.API(version="v2")
results = api.product.update(CODE, body)

with CODE the product barcode and body the update body.

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

Third party applications

If you use this SDK, feel free to open a PR to add your application in this list.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

openfoodfacts-0.1.12.tar.gz (28.6 kB view hashes)

Uploaded Source

Built Distribution

openfoodfacts-0.1.12-py3-none-any.whl (30.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page