Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/johnwmillr/spoonacularapi
🥄Python wrapper for the Spoonacular API 🥄
https://github.com/johnwmillr/spoonacularapi
api-wrapper food ingredients recipes spoonacular spoonacular-api
Last synced: about 2 months ago
JSON representation
🥄Python wrapper for the Spoonacular API 🥄
- Host: GitHub
- URL: https://github.com/johnwmillr/spoonacularapi
- Owner: johnwmillr
- License: mit
- Created: 2018-08-03T04:10:43.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-21T16:58:58.000Z (7 months ago)
- Last Synced: 2024-10-23T13:43:13.607Z (about 2 months ago)
- Topics: api-wrapper, food, ingredients, recipes, spoonacular, spoonacular-api
- Language: Python
- Homepage:
- Size: 42 KB
- Stars: 17
- Watchers: 4
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🥄 spoonacular 🥄
---
[](https://travis-ci.org/johnwmillr/SpoonacularAPI)
[](https://pypi.org/project/spoonacular/)
[](https://pypi.org/project/spoonacular/)
Want to parse a list of [ingredients](https://rapidapi.com/spoonacular/api/Recipe%20-%20Food%20-%20Nutrition/functions/Parse%20Ingredients) within a recipe? Or are you looking for a random [food joke](https://rapidapi.com/spoonacular/api/Recipe%20-%20Food%20-%20Nutrition/functions/Get%20a%20Random%20Food%20Joke)? These are just two of many endpoints provided by the marvelous [Spoonacular](https://spoonacular.com/) 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](https://pypi.python.org/pypi/spoonacular) using `pip`:
`$pip install spoonacular`
Thank you to [@sebbekarlsson](https://github.com/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](https://rapidapi.com/spoonacular/api/Recipe%20-%20Food%20-%20Nutrition/pricing) 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
```python
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
- [Spoonacular website](https://spoonacular.com/food-api)
- [RapidAPI](https://rapidapi.com/spoonacular/api/Recipe%20-%20Food%20-%20Nutrition)
- [DocScraper](https://github.com/johnwmillr/DocScraper)
## Collaboration
Please feel free to collaborate with a pull request or by opening an issue.