README.md

World-Food-Embeddings

Development setup

• Setup a python environment and install dependencies:

mkdir env
virtualenv --python=python3.8 ./env
source env/bin/activate
pip install -e ".[dev]"

This command will install all packages needed and pre-commit.

About pre-commit

• When running git commit -m, pre-commit will execute pre-defined hooks to perform compliant checks on the code.
• If needed (and possible), it will automatically modify the file/s to comply to the standard (flake8, mypy, etc)
• Modified files should be re-added with git add to be commited.
• The hooks are defined in the .pre-commit-config.yaml.