Metadata-Version: 2.1
Name: recipe-searchers
Version: 0.0.7
Summary: A webscraping package to search for recipes URL's
Home-page: https://github.com/MichielMag/recipe-searchers
Author: Michiel K
Author-email: michieL_m@live.nl
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: bs4
Requires-Dist: tldextract

# recipe-searchers
A simple web / api scraping tool for searching for recipe links, inspired by (and possibly for use with) [recipe-scapers](https://github.com/hhursev/recipe-scrapers).

## To install
```
pip install recipe-searchers
```

## To use
```python
from recipe_searchers import search_recipe

result = search_recipe("panna cotta")
print(f"Found results: \n {result}")
```
```search_recipe()``` returns an object in the form of:

```python
@dataclass
class SearchResult:
    keyword : str
    # str = website, List = results
    results : Dict[str, List[RecipeLink]]
```

Where results is a pair of Website for every website it has found results and a list of results.

## Searchers available for:
- [allrecipes.com](https://allrecipes.com) - Through scraping
- [bbc.co.uk](https://www.bbc.co.uk/food/) - Through scraping
- [bbcgoodfood.com](https://www.bbcgoodfood.com/) - Through scraping
- [bonappetit.com](https://www.bonappetit.com/) - Through scraping
- [food.com](https://www.food.com/) - Through REST API
- [thewoksoflife.com](https://thewoksoflife.com/) - Through scraping

