gazpacho is a web scraping library. It replaces requests and BeautifulSoup for most projects. gazpacho is small, simple, fast, and consistent. You should use it!
gazpacho is easy to use. To retrieve the contents of a web page use get. And to parse the retrieved contents use Soup.
The get function retrieves content from a web page:
from gazpacho import get
url = 'https://en.wikipedia.org/wiki/Gazpacho'
html = get(url)
print(html[:50])
# <!DOCTYPE html>
# <html class="client-nojs" lang="enThe get function also accepts optional params and headers for any GET request.
url = 'https://httpbin.org/anything'
get(url, params={'foo': 'bar', 'bar': 'baz'}, headers={'User-Agent': 'gazpacho'})The Soup object takes an HTML string and turns it into something parsable:
from gazpacho import Soup
soup = Soup(html)
str(soup)[:50]
# '<!DOCTYPE html>\n<html class="client-nojs" lang="en'In order to parse an HTML element inside of a Soup object, pass the desired tag and attributes (optional) to the find method:
# Original HTML: <span class="mw-headline" id="Ingredients_and_preparation">Ingredients and preparation</span>
results = soup.find('span', {'class': 'mw-headline'})The find method will either return a list of Soup objects if there are multiple elements that satisfy the tag and attribute constraints, or a single Soup object if there's just one:
print(results)
# [<span class="mw-headline" id="History">History</span>,
# <span class="mw-headline" id="Ingredients_and_preparation">Ingredients and preparation</span>,
# <span class="mw-headline" id="Variations">Variations</span>,
# <span class="mw-headline" id="In_Spain">In Spain</span>,
# <span class="mw-headline" id="Arranque_roteño">Arranque roteño</span>,
# <span class="mw-headline" id="Extremaduran_variations">Extremaduran variations</span>,
# <span class="mw-headline" id="La_Mancha_variations">La Mancha variations</span>,
# <span class="mw-headline" id="Castilian_variations">Castilian variations</span>,
# <span class="mw-headline" id="See_also">See also</span>,
# <span class="mw-headline" id="References">References</span>]The return behaviour of find can be adjusted and made more predictable with the mode argument {'auto', 'first', 'all'}:
soup.find('span', {'class': 'mw-headline'}, mode='first')
# <span class="mw-headline" id="History">History</span>Soup objects returned by the find method will have html, tag, attrs, and text attributes:
result = results[3]
print(result.html)
# <span class="mw-headline" id="In_Spain">In Spain</span>
print(result.tag)
# span
print(result.attrs)
# {'class': 'mw-headline', 'id': 'In_Spain'}
print(result.text)
# In SpainAnd, importantly, returned Soup objects can reimplement the find method!
gazpacho is production ready. The library currently powers quote, a python wrapper for the Goodreads Quote API. And a fully worked example of gazpacho in action is available here.
gazpacho is a drop-in replacement for most projects that use requests and BeautifulSoup:
import requests
from bs4 import BeautifulSoup
import pandas as pd
url = 'https://www.capfriendly.com/browse/active/2020/salary?p=1'
response = requests.get(url)
soup = BeautifulSoup(response.text, 'lxml')
df = pd.read_html(str(soup.find('table')))[0]
print(df[['PLAYER', 'TEAM', 'SALARY', 'AGE']].head(3))
# PLAYER TEAM SALARY AGE
# 0 1. Mitchell Marner TOR $16,000,000 22
# 1 2. Auston Matthews TOR $15,900,000 21
# 2 3. John Tavares TOR $15,900,000 28Powered by gazpacho:
from gazpacho import get, Soup
import pandas as pd
url = 'https://www.capfriendly.com/browse/active/2020/salary?p=1'
response = get(url)
soup = Soup(response)
df = pd.read_html(str(soup.find('table')))[0]
print(df[['PLAYER', 'TEAM', 'SALARY', 'AGE']].head(3))
# PLAYER TEAM SALARY AGE
# 0 1. Mitchell Marner TOR $16,000,000 22
# 1 2. Auston Matthews TOR $15,900,000 21
# 2 3. John Tavares TOR $15,900,000 28gazpacho is fast:
from gazpacho import Soup
%%timeit
soup = Soup(html)
soup.find('span', {'class': 'mw-headline'})
# 15 ms ± 325 µs per loop (mean ± std. dev. of 7 runs, 100 loops each)gazpacho is often 20-40% faster than BeautifulSoup:
from bs4 import BeautifulSoup
%%timeit
soup = BeautifulSoup(html, 'lxml')
soup.find('span', {'class': 'mw-headline'})
# 19.4 ms ± 583 µs per loop (mean ± std. dev. of 7 runs, 10 loops each)And 200-300% faster than requests-html:
from requests_html import HTML
%%timeit
soup = HTML(html=html)
soup.find('span.mw-headline')
# 40.1 ms ± 418 µs per loop (mean ± std. dev. of 7 runs, 10 loops each)pip install -U gazpacho
If you use gazpacho, consider adding the
[](https://github.com/maxhumber/gazpacho)For feature requests or bug reports, please use Github Issues.
For PRs, please read the CONTRIBUTING.md document.