Skip to content

johnwmillr/SpoonacularAPI

Repository files navigation

🥄 spoonacular 🥄


Build Status PyPI version Python version

Want to parse a list of ingredients within a recipe? Or are you looking for a random food joke? These are just two of many endpoints provided by the marvelous Spoonacular food and recipes API. spoonacular provides a simple Python interface to this API.

Installation

The easiest way to start using this package is to install it via PyPI using pip:

$pip install spoonacular

Thank you to @sebbekarlsson for transferring ownership of the original PyPI package name.

If you'd prefer to clone and install the repository manually, follow these steps:

  1. Clone this repo: $git clone https://github.com/johnwmillr/SpoonacularAPI.git
  2. Enter the cloned directory: $cd SpoonacularAPI
  3. Install: $python setup.py install

Usage

API Key

You'll need to sign up for an account on RapidAPI to start using spoonacular. Spoonacular is a freemium API, so you'll be able to start with 50 free calls a day. Registration requires a credit card number even for the free plan, because users are charged a small amount per call if they go over the daily limit. This package has a basic system in place to try and prevent overrage charges.

Examples

import spoonacular as sp
api = sp.API("your_api_key_here")

# Parse an ingredient
response = api.parse_ingredients("3.5 cups King Arthur flour", servings=1)
data = response.json()
print(data[0]['name'])
>>>"flour"

# Detect text for mentions of food
response = api.detect_food_in_text("I really want a cheeseburger.")
data = response.json()
print(data['annotations'][0])
>>>{"annotation": "cheeseburger", "tag":"dish"}

# Get a random food joke
response = api.get_a_random_food_joke()
data = response.json()
print(data['text'])
>>>"People are a lot less judgy when you say you ate an 'avocado salad' instead of a bowl of guacamole."

Documentation

Collaboration

Please feel free to collaborate with a pull request or by opening an issue.

Releases

No releases published

Packages

No packages published

Languages