recipebox_pkg
latest
  • Example usage
  • Changelog
  • Contributing
  • Code of Conduct
  • API Reference
    • recipebox_pkg
      • Submodules
        • recipebox_pkg.fetch_recipe
        • recipebox_pkg.id_search
        • recipebox_pkg.ing_search
        • recipebox_pkg.nutr_search
      • Package Contents
recipebox_pkg
  • API Reference
  • recipebox_pkg
  • recipebox_pkg.id_search
  • Edit on GitHub

recipebox_pkg.id_search

Module Contents

Classes

Recipe_id

class recipebox_pkg.id_search.Recipe_id(id, api_key)[source]
dict_reader(input_dict)[source]

Process a dictionary into a Pandas Series.

Parameters: - input_dict (dict): The input dictionary to process.

Returns: - pd.Series: Processed Pandas Series.

list_reader(input_dict)[source]

Process a dictionary into a Pandas Series.

Parameters: - input_dict (dict): The input dictionary to process.

Returns: - pd.Series: Processed Pandas Series.

search_ingredient_id()[source]

Search for ingredient information using the Spoonacular API.

Returns: - pd.DataFrame or None: A DataFrame containing ingredient information or None if an error occurs.

search_taste_id(recipe_id_list)[source]

Fetch taste information for a list of recipe IDs using the Spoonacular API.

Parameters: - recipe_id_list (list): A list of recipe IDs.

Returns: - pd.DataFrame: A DataFrame containing taste information for each recipe.

search_nutrient_id(selection='info')[source]

Fetch nutrition information for a recipe using the Spoonacular API.

Parameters: - selection (str, optional): Type of nutrition information to retrieve.

  • ‘info’: General information about nutrients, caloric breakdown, and weight per serving.

  • ‘table’: Detailed table of nutrient information.

Returns: - pd.DataFrame: A DataFrame containing the requested nutrition information.

search_equipment_id()[source]

Fetch equipment information for a recipe using the Spoonacular API.

Returns: - pd.DataFrame or None: A DataFrame containing equipment information or None if an error occurs.

search_instruction_id()[source]

Fetch analyzed instructions for a recipe using the Spoonacular API.

Returns: - list or str: A list of instruction steps or an error message if no instructions are found or an error occurs.

convert_instruction(list_in)[source]

Convert and print a list of instruction steps.

Parameters: - list_in (list): List of instruction steps.

Returns: - None

Previous Next

© Copyright 2023, Yuchen An. Revision 157f4184.

Built with Sphinx using a theme provided by Read the Docs.