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")
'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 advantage of some features of Python 3.

For this reason, I plan to discontinue Beautiful Soup's Python 2 support at some point after December 31, 2020: 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.9.2.tar.gz (375.9 kB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

beautifulsoup4-4.9.2-py3-none-any.whl (115.7 kB view details)

Uploaded Python 3

beautifulsoup4-4.9.2-py2-none-any.whl (115.8 kB view details)

Uploaded Python 2

File details

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

File metadata

  • Download URL: beautifulsoup4-4.9.2.tar.gz
  • Upload date:
  • Size: 375.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.2

File hashes

Hashes for beautifulsoup4-4.9.2.tar.gz
Algorithm Hash digest
SHA256 1edf5e39f3a5bc6e38b235b369128416c7239b34f692acccececb040233032a1
MD5 5672f9b9bdfb0c6ab3ef074396bf59aa
BLAKE2b-256 91f55be6a47f85552586e750b6939b4f21eb4f1b02ef0d0562f1bc3c5fb0ce78

See more details on using hashes here.

File details

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

File metadata

  • Download URL: beautifulsoup4-4.9.2-py3-none-any.whl
  • Upload date:
  • Size: 115.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.2

File hashes

Hashes for beautifulsoup4-4.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5dfe44f8fddc89ac5453f02659d3ab1668f2c0d9684839f0785037e8c6d9ac8d
MD5 4c4332b6153fef6f45bfc55de1214425
BLAKE2b-256 56f26c6c7d0b5483b8c63e837c3f5d941e511979ceb3975ca45fa3ef682df2d6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: beautifulsoup4-4.9.2-py2-none-any.whl
  • Upload date:
  • Size: 115.8 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.49.0 CPython/3.8.2

File hashes

Hashes for beautifulsoup4-4.9.2-py2-none-any.whl
Algorithm Hash digest
SHA256 645d833a828722357038299b7f6879940c11dddd95b900fe5387c258b72bb883
MD5 cdcb0e7b5ae881b2a13c38da872e3445
BLAKE2b-256 432e1cd0a1bc2faae7dc446b0cf8caf22900e64b9295fe01183c0d8fabf0667f

See more details on using hashes here.

Supported by

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