Skip to main content

Parses unstructured recipe ingredient text into standardized quantities, units, and foods

Project description

ingredient-slicer

Python 📦 package for extracting quantities, units, and food words from unstructured recipe ingredients text.

ingredient-slicer works by standardizing the input text and then applying a set of rules and heuristic methods to parse out quantities, units, and food words from unstructured recipe ingredients text. ingredient-slicer was designed to provide a robust and lightweight method for parsing recipe ingredients text without relying on any external dependencies or NLP/ML models. That being said, it is not perfect and can always be improved upon.

Table of Contents:


Installation:

ingredient_slicer can be downloaded from PyPI via pip like so:

pip install ingredient-slicer

Usage:

Provide a string to the IngredientSlicer class and thats it. Invoke the to_json() method to return the parsed ingredient.

import ingredient_slicer

slicer = ingredient_slicer.IngredientSlicer("2 (15-ounces) cans chickpeas, rinsed and drained")

slicer.to_json()

{   
    'ingredient': '2 (15-ounces) cans chickpeas, rinsed and drained', 
    'standardized_ingredient': '2 cans chickpeas, rinsed and drained', 
    'food': 'chickpeas', 

    # primary quantity and units
    'quantity': '30', 
    'unit': 'ounces', 
    'standardized_unit': 'ounce', 

    # any other secondary quantity and units found in the string
    'secondary_quantity': '2', 
    'secondary_unit': 'cans', 
    'standardized_secondary_unit': 'can', 

    'gram_weight': '850.49', 
    'prep': ['drained', 'rinsed'], 
    'size_modifiers': [], 
    'dimensions': [], 
    'is_required': True, 
    'parenthesis_content': ['15 ounce']
}

Individual ingredient components can also be found using methods like food(), quantity(), or unit()

import ingredient_slicer

slicer = ingredient_slicer.IngredientSlicer("3 tbsp unsalted butter, softened at room temperature")

slicer.food() 
>>> 'unsalted butter'

slicer.quantity() 
>>> '3' 

slicer.unit() 
>>> 'tbsp'

slicer.standardized_unit() 
>>> 'tablespoon'

slicer.prep() 
>>> ['room temperature', 'softened']

Contributing/Issues:

If you find a bug or have an idea for a new feature, please open an issue or submit a pull request.

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

ingredient_slicer-1.0.2.tar.gz (127.1 kB view hashes)

Uploaded Source

Built Distribution

ingredient_slicer-1.0.2-py3-none-any.whl (84.7 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