Skip to main content

Screen-scraping library

Project description

Beautiful Soup is a library that makes it easy to scrape information from web pages. It sits atop an HTML or XML parser, providing Pythonic idioms for iterating, searching, and modifying the parse tree.

Quick start

>>> from bs4 import BeautifulSoup
>>> soup = BeautifulSoup("<p>Some<b>bad<i>HTML")
>>> print soup.prettify()
<html>
<body>
<p>
Some
<b>
bad
<i>
HTML
</i>
</b>
</p>
</body>
</html>

>>> soup.find(text="bad")
u'bad'

>>> soup.i
<i>HTML</i>

>>> soup = BeautifulSoup("<tag1>Some<tag2/>bad<tag3>XML", "xml")
>>> print soup.prettify()
<?xml version="1.0" encoding="utf-8">
<tag1>
Some
<tag2 />
bad
<tag3>
XML
</tag3>
</tag1>

To go beyond the basics, comprehensive documentation is available.

Links

Note on Python 2 sunsetting

Since 2012, Beautiful Soup has been developed as a Python 2 library which is automatically converted to Python 3 code as necessary. This makes it impossible to take advantages of some features of Python 3.

For this reason, I plan to discontinue Beautiful Soup's Python 2 support at some point after January 1, 2021: one year after the sunset date for Python 2 itself. Beyond that point, new Beautiful Soup development will exclusively target Python 3. Of course, older releases of Beautiful Soup, which support both versions, will continue to be available.

Supporting the project

If you use Beautiful Soup as part of your professional work, please consider a Tidelift subscription. This will support many of the free software projects your organization depends on, not just Beautiful Soup.

If you use Beautiful Soup for personal projects, the best way to say thank you is to read Tool Safety, a zine I wrote about what Beautiful Soup has taught me about software development.

Building the documentation

The bs4/doc/ directory contains full documentation in Sphinx format. Run make html in that directory to create HTML documentation.

Running the unit tests

Beautiful Soup supports unit test discovery from the project root directory:

$ nosetests
$ python -m unittest discover -s bs4

If you checked out the source tree, you should see a script in the home directory called test-all-versions. This script will run the unit tests under Python 2, then create a temporary Python 3 conversion of the source and run the unit tests again under Python 3.

Project details


Download files

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

Source Distribution

beautifulsoup4-4.8.1.tar.gz (159.2 kB view details)

Uploaded Source

Built Distributions

beautifulsoup4-4.8.1-py3-none-any.whl (101.3 kB view details)

Uploaded Python 3

beautifulsoup4-4.8.1-py2-none-any.whl (102.4 kB view details)

Uploaded Python 2

File details

Details for the file beautifulsoup4-4.8.1.tar.gz.

File metadata

  • Download URL: beautifulsoup4-4.8.1.tar.gz
  • Upload date:
  • Size: 159.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/18.4 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.0+

File hashes

Hashes for beautifulsoup4-4.8.1.tar.gz
Algorithm Hash digest
SHA256 6135db2ba678168c07950f9a16c4031822c6f4aec75a65e0a97bc5ca09789931
MD5 be03d778cf61cf6734a480e2010d6657
BLAKE2b-256 86cd495c68f0536dcd25f016e006731ba7be72e072280305ec52590012c1e6f2

See more details on using hashes here.

File details

Details for the file beautifulsoup4-4.8.1-py3-none-any.whl.

File metadata

  • Download URL: beautifulsoup4-4.8.1-py3-none-any.whl
  • Upload date:
  • Size: 101.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/18.4 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.0+

File hashes

Hashes for beautifulsoup4-4.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 dcdef580e18a76d54002088602eba453eec38ebbcafafeaabd8cab12b6155d57
MD5 5e932397bb149eb4743305a927ff1a9e
BLAKE2b-256 3bc8a55eb6ea11cd7e5ac4bacdf92bac4693b90d3ba79268be16527555e186f0

See more details on using hashes here.

File details

Details for the file beautifulsoup4-4.8.1-py2-none-any.whl.

File metadata

  • Download URL: beautifulsoup4-4.8.1-py2-none-any.whl
  • Upload date:
  • Size: 102.4 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/18.4 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.5.0+

File hashes

Hashes for beautifulsoup4-4.8.1-py2-none-any.whl
Algorithm Hash digest
SHA256 5279c36b4b2ec2cb4298d723791467e3000e5384a43ea0cdf5d45207c7e97169
MD5 23f05a28b6a3e7ed1e9eec704e20b2a4
BLAKE2b-256 f9d9183705a87492249b212d88eef740995f55076195bcf45ed59306c146e42d

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