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.2.2.tar.gz (126.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ingredient_slicer-1.2.2-py3-none-any.whl (83.6 kB view details)

Uploaded Python 3

File details

Details for the file ingredient_slicer-1.2.2.tar.gz.

File metadata

  • Download URL: ingredient_slicer-1.2.2.tar.gz
  • Upload date:
  • Size: 126.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.4

File hashes

Hashes for ingredient_slicer-1.2.2.tar.gz
Algorithm Hash digest
SHA256 1730147d213ac5848db6cd816b93307eb29a8ab1c209ad8d4d816d012cebc82a
MD5 35e62ed707066f646c28ca452f5f5e2c
BLAKE2b-256 54b684dd7d8855fff3b9110e0f1c308e62e9ded9e7d5e7a417992f05624c010e

See more details on using hashes here.

File details

Details for the file ingredient_slicer-1.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for ingredient_slicer-1.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 0f6ce0eaa37434436d8ee09cbd0265f48a30ce9814e1f51055f1436ed95705da
MD5 66b70f5080865cb5ff5754b05c727fb0
BLAKE2b-256 487e64e5395eb3a020c34288c437af89d63a5dc2f672a7992b12782900c1ec58

See more details on using hashes here.

Supported by

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