Metadata-Version: 1.0
Name: breadability
Version: 0.1.0
Summary: Redone port of Readability API in Python
Home-page: http://docs.bmark.us
Author: Rick Harding
Author-email: rharding@mitechie.com
License: BSD
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:
        
        - http://code.google.com/p/arc90labs-readability/source/browse/trunk/js/readability.js#82
        
        
        Installation
        -------------
        Currently it's git only until I get everything ready for a submission to PyPi.
        
        
        Usage
        ------
        
        cmd line
        ~~~~~~~~~
        
        ::
        
            $ breadability http://wiki.python.org/moin/BeginnersGuide
        
        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 http://wiki.python.org/moin/BeginnersGuide
        
        
        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:
        
        - https://bmark.us
        - http://readable.bmark.us
        
        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.
        
        
        .. _readability: http://code.google.com/p/arc90labs-readability/
        
        
        .. This is your project NEWS file which will contain the release notes.
        .. Example: http://www.python.org/download/releases/2.6/NEWS.txt
        .. The content of this file, along with README.rst, will appear in your
        .. project's PyPI page.
        
        News
        ====
        
        0.2a1
        -----
        
        *Release date: UNRELEASED*
        
        * Example news entry for the in-development version
        
        
        0.1
        ---
        
        *Release date: 15-Mar-2010*
        
        * Example news entry for a released version
        
        
Keywords: readable parsing html content bookie
Platform: UNKNOWN
