Contributing to openfoodfacts-python

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:

• Anubhav Bhargava
• Frank Rousseau
• Pierre Slamich
• Raphaël

Contributors:

• Agamit Sudo
• Daniel Stolpe
• Enioluwa Segun
• Nicolas Leger
• Pablo Hinojosa
• Andrea Stagi
• Benoît Prieur
• Aadarsh A

How to install on your local machine

Make sure you have uv installed, then run:

uv sync --all-extras

Install pre-commit hooks

This repo uses pre-commit to enforce code styling, etc. To install it, run the following:

uv run pre-commit install

Now pre-commit will run automatically on git commit :)

Write and run tests

You should create basic tests for each new feature or API change.

To run tests locally, just launch:

uv run pytest tests