Skip to main content

Python package, scraping recipes from all over the internet

Project description

Github Version PyPI - Python Version Downloads GitHub Actions Unittests Coveralls License Codacy Badge

A simple web scraping tool for recipe sites.

pip install recipe-scrapers

then:

import requests
from recipe_scrapers import scrape_html

# give the url as a string, it can be url from any site listed below
url = "https://www.allrecipes.com/recipe/158968/spinach-and-feta-turkey-burgers/"
html = requests.get(url).content
scraper = scrape_html(html, org_url=url)

# 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.
url = 'https://www.feastingathome.com/tomato-risotto/'
html = requests.get(url).content
scraper = scrape_html(html, org_url=url, 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.to_json()
scraper.links()
scraper.nutrients()  # if available
scraper.canonical_url()  # also not always available

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:

(*) offline saved files only. Page requires login

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. You can find documentation on how to develop scrapers here.

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.

      You can find a more detailed guide here.

For Devs / Contribute

Assuming you have >=python3.8 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 &&
python -m venv .venv &&
source .venv/bin/activate &&
python -m pip install --upgrade pip &&
pip install -r requirements-dev.txt &&
pip install pre-commit &&
pre-commit install &&
python -m unittest

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

python -m unittest -k <test_file_name>

FAQ

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

from recipe_scrapers import scrape_html
url = '<url of a recipe from the site>'
html = requests.get(url).content
scraper = scrape_html(html, org_url=url, 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 robotexclusionrulesparser library.

Special thanks to:

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

https://contrib.rocks/image?repo=hhursev/recipe-scrapers

Extra:

You want to gather recipes data?
You have an idea you want to implement?
Check out our “Share a project” wall - it may save you time and spark ideas!

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-15.0.0rc1.tar.gz (85.6 kB view details)

Uploaded Source

Built Distribution

recipe_scrapers-15.0.0rc1-py3-none-any.whl (192.2 kB view details)

Uploaded Python 3

File details

Details for the file recipe_scrapers-15.0.0rc1.tar.gz.

File metadata

  • Download URL: recipe_scrapers-15.0.0rc1.tar.gz
  • Upload date:
  • Size: 85.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.6

File hashes

Hashes for recipe_scrapers-15.0.0rc1.tar.gz
Algorithm Hash digest
SHA256 5e08669458ca3a9399bf098529579e9a35be3352cf1d9863836994366c2929b9
MD5 bcb5c1fad4935bdc5571fdfe2a0ae3b7
BLAKE2b-256 fa3f077c37a6eb8f5bb5caf1f4b94bb1da781f9baf6135179a71d4a936695377

See more details on using hashes here.

File details

Details for the file recipe_scrapers-15.0.0rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for recipe_scrapers-15.0.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 81b98e5f4d022afc46f85f4208aaa9041ad6311923fcf8b73e053a3ffc6f68ad
MD5 02ee1e0802e9ff93ec1e6b7d70d403ef
BLAKE2b-256 68758629d2936b276c805fda7689ff45c831770bb79304a790ed5e8aff793c46

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