A Python wrapper for the Spoonacular API
Project description
🥄 spoonacular 🥄
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:
- Clone this repo:
$git clone https://github.com/johnwmillr/SpoonacularAPI.git
- Enter the cloned directory:
$cd SpoonacularAPI
- 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
Built Distribution
File details
Details for the file spoonacular-3.0.tar.gz
.
File metadata
- Download URL: spoonacular-3.0.tar.gz
- Upload date:
- Size: 10.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.20.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a0e7f12d84342a79bf313f1c6385175f6651771d2de7381d06430a1c4b678241 |
|
MD5 | c67703e543d38d94f8f864180f87e541 |
|
BLAKE2b-256 | ff21541150521dc25fdfd8f10bcbcf6d6b227b2ed30ae1244c15320a375b39d3 |
File details
Details for the file spoonacular-3.0-py3-none-any.whl
.
File metadata
- Download URL: spoonacular-3.0-py3-none-any.whl
- Upload date:
- Size: 10.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.20.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | b655241d8c85bcf8ccf6b0d6c0c6279c5cba74760965275989e93d820fdac1f7 |
|
MD5 | 8de1248ec77b4e927044f37c6f8686e8 |
|
BLAKE2b-256 | 188331f74bf9452a597b545db89a7a2e172c7c24be3948b3657fb582c26cc43d |