Skip to main content

A Python wrapper for the Spoonacular API

Project description

🥄 spoonacular 🥄


Build Status 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 for @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.0.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.0-py3-none-any.whl (7.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: spoonacular-2.0.0.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.0.tar.gz
Algorithm Hash digest
SHA256 6c1494011431e56f78bf11b00c87c1d039f45f012c999a40a8fe2f0ee60f4b29
MD5 99fdd2c39b2a0a87b6ac6d2c0071ba7a
BLAKE2b-256 66a3dc199cd29d33a3ace855e8aa5f28e76a71e378c96c63903c401eb9179f57

See more details on using hashes here.

File details

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

File metadata

  • Download URL: spoonacular-2.0.0-py3-none-any.whl
  • Upload date:
  • Size: 7.5 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 bda1376348e0a6950020cf764718f3e037ecd98397e46d0c42836b5a3aafec9a
MD5 7df6b2185e9a5f86171db1b5911a40b3
BLAKE2b-256 885f6adc1df361dc97dab12545c02e1c1d4f94184853063d123e1e2a98234923

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