Skip to main content

A Python wrapper for the Spoonacular API

Project description

🥄 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.

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

spoonacular-2.0.1.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

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

spoonacular-2.0.1-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

Details for the file spoonacular-2.0.1.tar.gz.

File metadata

  • Download URL: spoonacular-2.0.1.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.1.0 requests-toolbelt/0.8.0 tqdm/4.19.8 CPython/2.7.15

File hashes

Hashes for spoonacular-2.0.1.tar.gz
Algorithm Hash digest
SHA256 cd03069fbdceba4507805ef6445b1c4fd9e084b27b7696220129f4c85f68d1fd
MD5 82e6c3702df33533123b516c4bf8f2c2
BLAKE2b-256 852d52ffab469991fb707e9fe07daa66fe2f35e27f8823d99055c8a73db84b6d

See more details on using hashes here.

File details

Details for the file spoonacular-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: spoonacular-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 7.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.18.4 setuptools/39.1.0 requests-toolbelt/0.8.0 tqdm/4.19.8 CPython/2.7.15

File hashes

Hashes for spoonacular-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 30575abe919b594cf2279e67cf9bdae0bdf7730c4316bec768b59ab14b5fd835
MD5 53dac86af94f7aacea76df82b2745b8b
BLAKE2b-256 8b3e521592cb651a64e9bda0f178566816910f04d9a9f48b3cc58ad651cc650b

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