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

Uploaded Source

Built Distribution

ingredient_slicer-1.1.17-py3-none-any.whl (74.0 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ingredient_slicer-1.1.17.tar.gz
Algorithm Hash digest
SHA256 90e78ca892925241cb00a9d6af7efc6b304a260747dc7c1ab6be661387157b0d
MD5 65cf096004a25feb20eaf7b507c88c25
BLAKE2b-256 69c78c34ab86256f53fafbb3b9f02bf99780600dafc063c81e62447bbfe3249c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for ingredient_slicer-1.1.17-py3-none-any.whl
Algorithm Hash digest
SHA256 ee6e9c9aaaf5969fb2e0b670a83a78f8f7fb248f360e6b8174ad2e4ccca9805b
MD5 dd244aa6d38f7dd9cf96ba237000bfae
BLAKE2b-256 10e3224325a8c1e9ce1bf1e79c3620953177e42d834c1fe88e6c42809dd8937f

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