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 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.1.tar.gz (374.8 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.1-py3-none-any.whl (115.1 kB view details)

Uploaded Python 3

beautifulsoup4-4.9.1-py2-none-any.whl (111.8 kB view details)

Uploaded Python 2

File details

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

File metadata

  • Download URL: beautifulsoup4-4.9.1.tar.gz
  • Upload date:
  • Size: 374.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/3.7.0

File hashes

Hashes for beautifulsoup4-4.9.1.tar.gz
Algorithm Hash digest
SHA256 73cc4d115b96f79c7d77c1c7f7a0a8d4c57860d1041df407dd1aae7f07a77fd7
MD5 57502b5b34ccfd97b180260071f5799a
BLAKE2b-256 c6628a2bef01214eeaa5a4489eca7104e152968729512ee33cb5fbbc37a896b7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: beautifulsoup4-4.9.1-py3-none-any.whl
  • Upload date:
  • Size: 115.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/3.7.0

File hashes

Hashes for beautifulsoup4-4.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a6237df3c32ccfaee4fd201c8f5f9d9df619b93121d01353a64a73ce8c6ef9a8
MD5 5668f6609f3a7c2cb5fecd8e8ca86f36
BLAKE2b-256 6625ff030e2437265616a1e9b25ccc864e0371a0bc3adb7c5a404fd661c6f4f6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: beautifulsoup4-4.9.1-py2-none-any.whl
  • Upload date:
  • Size: 111.8 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.21.0 setuptools/40.6.3 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/3.7.0

File hashes

Hashes for beautifulsoup4-4.9.1-py2-none-any.whl
Algorithm Hash digest
SHA256 e718f2342e2e099b640a34ab782407b7b676f47ee272d6739e60b8ea23829f2c
MD5 d5ef18b9fb71428198a9fde785710b14
BLAKE2b-256 c2391efce3dc73e657c43f436533d49be1491bf8fc830caa70188d73bfd03b8d

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