Skip to main content

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 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.

Release files for beautifulsoup4 4.8.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for beautifulsoup4 4.8.2
File Size Uploaded
beautifulsoup4-4.8.2.tar.gz 298.6 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for beautifulsoup4 4.8.2
File Interpreter ABI Platform
beautifulsoup4-4.8.2-py3-none-any.whl Python 3 none any Details
beautifulsoup4-4.8.2-py2-none-any.whl Python 2 none any Details

Total release size: 512.5 kB

Release files / beautifulsoup4-4.8.2.tar.gz

Download URL beautifulsoup4-4.8.2.tar.gz
Size 298.6 kB
Tags Source
SHA-256 checksum
How to use checksums
05fd825eb01c290877657a56df4c6e4c311b3965bda790c613a3d6fb01a5462a
BLAKE2b-256 checksum
How to use checksums
52ba0e121661f529e7f456e903bf5c4d255b8051d8ce2b5e629c5212efe4c3f1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.7.0

Release files / beautifulsoup4-4.8.2-py3-none-any.whl

Download URL beautifulsoup4-4.8.2-py3-none-any.whl
Size 106.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9fbb4d6e48ecd30bcacc5b63b94088192dcda178513b2ae3c394229f8911b887
BLAKE2b-256 checksum
How to use checksums
cba1c698cf319e9cfed6b17376281bd0efc6bfc8465698f54170ef60a485ab5d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.7.0

Release files / beautifulsoup4-4.8.2-py2-none-any.whl

Download URL beautifulsoup4-4.8.2-py2-none-any.whl
Size 107.0 kB
Tags Python 2
SHA-256 checksum
How to use checksums
e1505eeed31b0f4ce2dbb3bc8eb256c04cc2b3b72af7d551a4ab6efd5cbe5dae
BLAKE2b-256 checksum
How to use checksums
c548c88b0b390ae1f785942fc83413feb1268a1eb696f343d4d55db735b9bb39
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/3.7.0

Release history Release notifications | RSS feed

4.14.3

2 release files

4.14.2

2 release files

4.14.1

2 release files

4.14.0

2 release files

4.13.5

2 release files

4.13.4

2 release files

4.12.3

2 release files

4.12.0

2 release files

4.11.2

2 release files

4.9.3

3 release files

4.9.2

3 release files

4.9.1

3 release files

4.9.0

3 release files

This release

4.8.2 This release

3 release files

4.8.1

3 release files

4.8.0

3 release files

4.7.1

3 release files

4.7.0

3 release files

4.6.3

3 release files

4.6.2

3 release files

4.6.1

5 release files

4.6.0

3 release files

4.5.3

3 release files

4.5.2

2 release files

4.5.1

3 release files

4.5.0

3 release files

4.4.1

3 release files

4.4.0

3 release files

4.3.2

1 release file

4.3.1

1 release file

4.3.0

1 release file

4.2.1

1 release file

4.2.0

1 release file

4.1.3

1 release file

4.1.2

1 release file

4.1.1

1 release file

4.1.0

1 release file

4.0.5

1 release file

4.0.4

1 release file

4.0.3

1 release file

4.0.2

1 release file

4.0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page