fast html to text parser (article readability tool) with python 3 support
Project Links
Meta
Author: Yuri Baburov
Classifiers
Environment
- Web Environment
Intended Audience
- Developers
Operating System
- OS Independent
Topic
- Text Processing :: Indexing
- Utilities
- Internet
- Software Development :: Libraries :: Python Modules
Programming Language
- Python
- Python :: 3
- Python :: 3.8
- Python :: 3.9
- Python :: 3.10
- Python :: 3.11
- Python :: 3.12
- Python :: 3.13
- Python :: Implementation :: PyPy
python-readability
Given an HTML document, extract and clean up the main body text and title.
This is a Python port of a Ruby port of arc90's Readability project.
Installation
It's easy using pip, just run:
$ pip install readability-lxml
As an alternative, you may also use conda to install, just run:
$ conda install -c conda-forge readability-lxml
Usage
>>> import requests
>>> from readability import Document
>>> response = requests.get('http://example.com')
>>> doc = Document(response.content)
>>> doc.title()
'Example Domain'
>>> doc.summary()
"""<html><body><div><body id="readabilityBody">\n<div>\n <h1>Example Domain</h1>\n
<p>This domain is established to be used for illustrative examples in documents. You may
use this\n domain in examples without prior coordination or asking for permission.</p>
\n <p><a href="http://www.iana.org/domains/example">More information...</a></p>\n</div>
\n</body>\n</div></body></html>"""
Change Log
- 0.8.4 Better CJK support, thanks @cdhigh
- 0.8.3.1 Support for python 3.8 - 3.13
- 0.8.3 We can now save all images via keep_all_images=True (default is to save 1 main image), thanks @botlabsDev
- 0.8.2 Added article author(s) (thanks @mattblaha)
- 0.8.1 Fixed processing of non-ascii HTMLs via regexps.
- 0.8 Replaced XHTML output with HTML5 output in summary() call.
- 0.7.1 Support for Python 3.7 . Fixed a slowdown when processing documents with lots of spaces.
- 0.7 Improved HTML5 tags handling. Fixed stripping unwanted HTML nodes (only first matching node was removed before).
- 0.6 Finally a release which supports Python versions 2.6, 2.7, 3.3 - 3.6
- 0.5 Preparing a release to support Python versions 2.6, 2.7, 3.3 and 3.4
- 0.4 Added Videos loading and allowed more images per paragraph
- 0.3 Added Document.encoding, positive_keywords and negative_keywords
Licensing
This code is under the Apache License 2.0 license.
Thanks to
- Latest readability.js
- Ruby port by starrhorne and iterationlabs
- Python port by gfxmonk
- Decruft effort to move to lxml
- "BR to P" fix from readability.js which improves quality for smaller texts
- Github users contributions.
0.8.4.1
May 03, 2025
0.8.4
May 03, 2025
0.8.1
Jul 04, 2020
0.7.1
Apr 29, 2019
0.7
May 07, 2018
0.6.2
Apr 11, 2016
0.6.1
Aug 26, 2015
0.6.0.5
Jul 27, 2015
0.6.0.4
Jul 27, 2015
0.6.0.3
Jul 26, 2015
0.5.1
May 06, 2015
0.5
Apr 27, 2015
0.3.0.6
Mar 16, 2015
0.3.0.5
Sep 22, 2014
0.3.0.3
Apr 02, 2014
0.3.0.2
Oct 10, 2013
0.3.0.1
Oct 09, 2013
0.3
Oct 09, 2013
0.2.6.1
Jul 17, 2012
0.2.6
Jun 21, 2012
0.2.5
Apr 19, 2012
0.2.3
Jul 26, 2011
0.2.2
Jul 26, 2011
0.2.1
Jul 01, 2011
0.2
Jun 30, 2011