Skip to main content

Python package, scraping recipes from all over the internet

Project description

Github Version Downloads GitHub Actions Unittests Coveralls License GitHub Actions Linters Black formatted Looks Good To Me

A simple web scraping tool for recipe sites.

pip install recipe-scrapers

then:

from recipe_scrapers import scrape_me

# give the url as a string, it can be url from any site listed below
scraper = scrape_me('https://www.allrecipes.com/recipe/158968/spinach-and-feta-turkey-burgers/')

# Q: What if the recipe site I want to extract information from is not listed below?
# A: You can give it a try with the wild_mode option! If there is Schema/Recipe available it will work just fine.
scraper = scrape_me('https://www.feastingathome.com/tomato-risotto/', wild_mode=True)

scraper.title()
scraper.total_time()
scraper.yields()
scraper.ingredients()
scraper.instructions()  # or alternatively for results as a Python list: scraper.instructions_list()
scraper.image()
scraper.host()
scraper.links()
scraper.nutrients()  # if available

# Starting from version 14.0.0 you also have an option to scrape from html-like content
import requests
from recipe_scrapers import scrape_html

url = "https://www.allrecipes.com/recipe/158968/spinach-and-feta-turkey-burgers/"
html = requests.get(url).content

scraper = scrape_html(html=html, org_url=url)

scraper.title()
scraper.total_time()
# etc...

Notes:

  • scraper.links() returns a list of dictionaries containing all of the <a> tag attributes. The attribute names are the dictionary keys.

Scrapers available for:

Contribute

If you spot a design change (or something else) that makes the scraper unable to work for a given site - please fire an issue asap.

If you are programmer PRs with fixes are warmly welcomed and acknowledged with a virtual beer.

If you want a scraper for a new site added

  • Open an Issue providing us the site name, as well as a recipe link from it.

  • You are a developer and want to code the scraper on your own:

    • If Schema is available on the site - you can go like this.

    • Otherwise, scrape the HTML - like this

    • Generating a new scraper class:

      python generate.py <ClassName> <URL>
      • ClassName: The name of the new scraper class.

      • URL: The URL of an example recipe from the target site. The content will be stored in test_data to be used with the test class.

For Devs / Contribute

Assuming you have >=python3.7 installed, navigate to the directory where you want this project to live in and drop these lines

git clone git@github.com:hhursev/recipe-scrapers.git &&
cd recipe-scrapers &&
python3 -m venv .venv &&
source .venv/bin/activate &&
pip install -r requirements-dev.txt &&
pre-commit install &&
python run_tests.py

In case you want to run a single unittest for a newly developed scraper

python -m coverage run -m unittest tests.test_myscraper

FAQ

  • How do I know if a website has a Recipe Schema? Run in python shell:

from recipe_scrapers import scrape_me
scraper = scrape_me('<url of a recipe from the site>', wild_mode=True)
# if no error is raised - there's schema available:
scraper.title()
scraper.instructions()  # etc.

Netiquette

If you’re using this library to collect large numbers of recipes from the web, please use the software responsibly and try to avoid creating high volumes of network traffic.

Python’s standard library provides a robots.txt parser that may be helpful to automatically follow common instructions specified by websites for web crawlers.

Another parser option – particularly if you find that many web requests from urllib.robotparser are blocked – is the robotsexclusionparser library.

Special thanks to:

All the contributors that helped improving the package. You are awesome!

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

recipe_scrapers-14.18.0.tar.gz (71.7 kB view details)

Uploaded Source

Built Distribution

recipe_scrapers-14.18.0-py3-none-any.whl (449.6 kB view details)

Uploaded Python 3

File details

Details for the file recipe_scrapers-14.18.0.tar.gz.

File metadata

  • Download URL: recipe_scrapers-14.18.0.tar.gz
  • Upload date:
  • Size: 71.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for recipe_scrapers-14.18.0.tar.gz
Algorithm Hash digest
SHA256 50d36558f36c86532ecd91594314329b3a6e31f8586aad3c299c1994cabcab57
MD5 6e4196306ffbc2b3bc97b5a7e9987cfd
BLAKE2b-256 4935ab9b0a274bffcb1c45ed08b9127b3b14294b72a50baea528a323223423d6

See more details on using hashes here.

File details

Details for the file recipe_scrapers-14.18.0-py3-none-any.whl.

File metadata

File hashes

Hashes for recipe_scrapers-14.18.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0a5b0f31d84808241db04d60cee28ff72ae881f7da205b164b3b5c031ff766c9
MD5 4ca8deabdf3c7fcdaf50a7ff37300e83
BLAKE2b-256 70c660685aaa2e337d103a493da4a6747f97ac2e6a5f494db64eb121d0c74189

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page