Skip to main content

Redone port of Readability API in Python

Project description

breadability - another readability Python port

I’ve tried to work with the various forks of some ancient codebase that ported readability to Python. The lack of tests, unused regex’s, and commented out sections of code in other Python ports just drove me nuts.

I put forth an effort to bring in several of the better forks into one codebase, but they’ve diverged so much that I just can’t work with it.

So what’s any sane person to do? Re-port it with my own repo, add some tests, infrastructure, and try to make this port better. OSS FTW (and yea, NIH FML, but oh well I did try)

This is a pretty straight port of the JS here:


Currently it’s git only until I get everything ready for a submission to PyPi.


cmd line

$ breadability

Add the -v flag to get some details on how we actually parsed this thing. I want to grow that debugging info into enough to try to track good/bad things we did in processing.

$ breadability -v

Using from Python

from breadability.readable import Article
readable_article = Article(html_text, url=url_came_from)
print readable_article

Work to be done

Yep, I’ve got some catching up to do. I don’t do pagination, I’ve got a lot of custom tweaks I need to get going, there are some articles that fail to parse. I also have more tests to write on a lot of the cleaning helpers, but hopefully things are setup in a way that those can/will be added.

Fortunately, I need this library for my tools:

so I really need this to be an active and improving project.

Off the top of my heads todo list:

  • Support metadata from parsed article [url, confidence scores, all candidates we thought about?]

  • More tests, more thorough tests

  • More sample articles we need to test against in the test_articles

  • Tests that run through and check for regressions of the test_articles

  • Tidy’ing the HTML that comes out, might help with regression tests ^^

  • Multiple page articles

  • Performance tuning, we do a lot of looping and re-drop some nodes that should be skipped. We should have a set of regression tests for this so that if we implement a change that blows up performance we know it right away.

  • Get up on pypi along with the rest of the ports

  • More docs for things, but sphinx docs and in code comments to help understand wtf we’re doing and why. That’s the biggest hurdle to some of this stuff.

Helping out

If you want to help, shoot me a pull request, an issue report with broken urls, etc.

You can ping me on irc, I’m always in the #bookie channel in freenode.



Release date: UNRELEASED

  • Example news entry for the in-development version


Release date: 15-Mar-2010

  • Example news entry for a released version

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

breadability-0.1.0.tar.gz (17.2 kB view hashes)

Uploaded Source

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