Skip to main content

A library for tagging, classify and calculate the water footprint of food recipes

Project description

Recipe Tagger

This package provides a classification, a tagging system and a water footprint calculator for ingredients and recipes.
The functioning of the package is based on a dataset containing more than 700 ingredients mapped with their own class and water footprint. If a provided ingredient is not mapped into the dataset, the library search for it on wikipedia pages, into the dictionary and into NLTK Wordnet to find the best possible class. The water footprint is computed based on its ingredients. Every ingredient has a water footprint, measured in l/kg.

An ingredient could be classified in one of the following class:

  • Vegetable
  • Fruit
  • Legume
  • Meat
  • Egg
  • Diary
  • Staple
  • Condiment
  • Nut
  • Seafood
  • Snack
  • Mushroom
  • Dessert
  • Beverage

A recipe is tagged based on its ingredients class. The library also provides a function to get the class percentage of recipe ingredients.

Installation

pip install recipe_tagger

Recipe Tagger module

How to use

from recipe_tagger import recipe_tagger

Get the class of a single ingredient

recipe_tagger.get_ingredient_class('aubergine')
# vegetable

Get tags of a recipe (it is needed to provide all the ingredient of the recipe)

recipe_tagger.get_recipe_tags(['aubergine', 'chicken'])
# ['vegetable', 'meat']

Get class percentage of a recipe (it is needed to provide all the ingredient of the recipe)

recipe_tagger.get_recipe_class_percentage(['aubergine', 'chicken', 'beef'])
# [('vegetable', '33.33%'), ('meat', '66.67%')]

Recipe Water Footprint module

How to use

from recipe_tagger import recipe_waterfootprint as wf

Get the water footprint of a single ingredient

wf.get_ingredient_waterfootprint("tomato", 20, process=True, language="en")
# 4.28

Get the water footprint of a recipe (it is needed to prived all the ingredients and the quantity of the recipe)

In order to provide a precise calculation of the WF, it is needed to provide also the quantity used for the ingredient in the recipe. Quanities must be provided matching the following pattern: "{number}{unit}". Unit can be one of ml, gr, kg, l, ounce, teaspoon, tablespoon, cup, pint quart, gallon, pound, clove, lb, or their abbreviation.

wf.get_recipe_waterfootprint(
            ["tomato", "apple", "chicken"], 
            ["20gr", "5ml", "1l"], 
            language="en")
# 4329.28

Get the water footprint of a recipe and informations about the ingredients water footprint

wf.get_recipe_waterfootprint(
            ["tomato", "apple", "chicken"],
            ["20gr", "5ml", "1l"],
            language="en",
            information=True,
        )
# (4329.28, {"tomato": 4.28, "apple": 0.0, "chicken": 4325.0})

Language support

Every method of the package provide the language support. Use the "language" parameter along with the abbreviation of a supported language. Default language is English, if the "language" argument is not provided.

  • English ("en")
  • Italian ("it")

Todo

  • Handling of Wikipedia pages.
  • Better search over dictionary and Wikipedia pages of ingredient.
  • Calculate the water foorprint of a recipe
  • Add the possibility to add an ingredient after search if it is not present into the embedding.
  • An explanation in order to provided an other language.
  • A method for automatic translation when providing another language.

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

recipe-tagger-0.4.13.tar.gz (35.0 kB view details)

Uploaded Source

File details

Details for the file recipe-tagger-0.4.13.tar.gz.

File metadata

  • Download URL: recipe-tagger-0.4.13.tar.gz
  • Upload date:
  • Size: 35.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.8.12

File hashes

Hashes for recipe-tagger-0.4.13.tar.gz
Algorithm Hash digest
SHA256 8e67bd3f9c9bd0167d495838b44bf2bdfa418f8b6893bfcf52fc17301bf583a2
MD5 9dd06553eea030fd0639ebb44e392aca
BLAKE2b-256 e7351ad56d523d4ef84904689a44b051bda93bca75d8bf3fc96ce2af207d8e84

See more details on using hashes here.

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