Renamed to readability

CHANGELOG.rst

@@ -1,7 +1,8 @@
 .. :changelog:
 
-Changelog for breadability
+Changelog for readability
 ==========================
+- Renamed package to readability.
 - Added support for Python >= 3.2.
 - Py3k compatible package 'charade' is used instead of 'chardet'.
 
@@ -39,7 +40,7 @@ Changelog for breadability
 
 0.1.4 (June 16th 2012)
 ----------------------
-- Add a test generation helper breadability_newtest script.
+- Add a test generation helper readability_newtest script.
 - Add tests and fixes for the scripting news parse failure.
 
 0.1.3 (June 15th 2012)

README.rst

@@ -1,7 +1,7 @@
-breadability - another readability Python port
+Readability.py - another readability Python port
 ==============================================
-.. image:: https://api.travis-ci.org/miso-belica/breadability.png?branch=master
+.. image:: https://api.travis-ci.org/miso-belica/readability.py.png?branch=master
-   :target: https://travis-ci.org/miso-belica/breadability
+   :target: https://travis-ci.org/miso-belica/readability.py
 
 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
@@ -27,14 +27,14 @@ things from pip so that it can compile.
 .. code-block:: bash
 
     $ [sudo] apt-get install libxml2-dev libxslt-dev
-    $ [sudo] pip install git+git://github.com/miso-belica/breadability.git
+    $ [sudo] pip install git+git://github.com/miso-belica/readability.py.git
 
 Tests
 -----
 .. code-block:: bash
 
-    $ nosetests --with-coverage --cover-package=breadability --cover-erase tests
+    $ nosetests --with-coverage --cover-package=readability --cover-erase tests
-    $ nosetests-3.3 --with-coverage --cover-package=breadability --cover-erase tests
+    $ nosetests-3.3 --with-coverage --cover-package=readability --cover-erase tests
 
 
 Usage
@@ -44,7 +44,7 @@ Command line
 
 .. code-block:: bash
 
-    $ breadability http://wiki.python.org/moin/BeginnersGuide
+    $ readability http://wiki.python.org/moin/BeginnersGuide
 
 Options
 ```````
@@ -66,7 +66,7 @@ Python API
 
     from __future__ import print_function
 
-    from breadability.readable import Article
+    from readability.readable import Article
 
 
     if __name__ == "__main__":

readability/document.py

@@ -15,7 +15,7 @@ from ._py3k import unicode, to_string, to_bytes
 from .utils import cached_property
 
 
-logger = logging.getLogger("breadability")
+logger = logging.getLogger("readability")
 
 
 def determine_encoding(page):

readability/readable.py

@@ -36,7 +36,7 @@ NULL_DOCUMENT = """
 </html>
 """
 
-logger = logging.getLogger("breadability")
+logger = logging.getLogger("readability")
 
 
 def ok_embedded_video(node):

readability/scoring.py

@@ -36,7 +36,7 @@ CLS_WEIGHT_NEGATIVE = re.compile(
     re.IGNORECASE
 )
 
-logger = logging.getLogger("breadability")
+logger = logging.getLogger("readability")
 
 
 def check_node_attributes(pattern, node, *attributes):

readability/scripts/client.py

@@ -4,9 +4,9 @@
 A fast python port of arc90's readability tool
 
 Usage:
-    breadability [options] <resource>
+    readability [options] <resource>
-    breadability --version
+    readability --version
-    breadability --help
+    readability --help
 
 Arguments:
   <resource>      URL or file path to process in readable form.
@@ -42,7 +42,7 @@ def parse_args():
 
 def main():
     args = parse_args()
-    logger = logging.getLogger("breadability")
+    logger = logging.getLogger("readability")
 
     if args["--verbose"]:
         logger.setLevel(logging.DEBUG)

readability/scripts/newtest.py

@@ -1,12 +1,12 @@
 # -*- coding: utf8 -*-
 
 """
-Helper to generate a new set of article test files for breadability.
+Helper to generate a new set of article test files for readability.
 
 Usage:
-    breadability_newtest -n <name> <url>
+    readability_newtest -n <name> <url>
-    breadability_newtest --version
+    readability_newtest --version
-    breadability_newtest --help
+    readability_newtest --help
 
 Arguments:
   <url>                   The url of content to fetch for the article.html
@@ -44,7 +44,7 @@ try:
 except ImportError:
     import unittest
 
-from breadability.readable import Article
+from readability.readable import Article
 
 
 class TestArticle(unittest.TestCase):

setup.py

@@ -2,7 +2,7 @@ import sys
 
 from os.path import abspath, dirname, join
 from setuptools import setup, find_packages
-from breadability import __version__
+from readability import __version__
 
 
 CURRENT_DIRECTORY = abspath(dirname(__file__))
@@ -29,20 +29,20 @@ if sys.version_info < (2, 7):
 
 
 setup(
-    name="breadability",
+    name="readability",
     version=__version__,
-    description="Port of Readability API in Python",
+    description="Port of Readability HTML parser in Python",
     long_description=long_description,
     keywords=[
+        "readability",
         "readable",
         "parsing",
-        "html",
+        "HTML",
         "content",
-        "bookie",
     ],
-    author="Rick Harding",
+    author="Michal Belica",
-    author_email="rharding@mitechie.com",
+    author_email="miso.belica@gmail.com",
-    url="http://docs.bmark.us",
+    url="https://github.com/miso-belica/readability.py",
     license="BSD",
     classifiers=[
         "Development Status :: 5 - Production/Stable",
@@ -71,8 +71,8 @@ setup(
     test_suite="tests.run_tests.run",
     entry_points={
         "console_scripts": [
-            "breadability=breadability:client.main",
+            "readability=readability:client.main",
-            "breadability_newtest=breadability:newtest.main",
+            "readability_newtest=breadability:newtest.main",
         ]
     }
 )

tests/run_tests.py

@@ -12,7 +12,7 @@ from os.path import dirname, abspath
 DEFAULT_PARAMS = [
     "nosetests",
     "--with-coverage",
-    "--cover-package=breadability",
+    "--cover-package=readability",
     "--cover-erase",
 ]
 

tests/test_articles/test_antipope_org/test.py

@@ -5,7 +5,7 @@ try:
 except ImportError:
     import unittest
 
-from breadability.readable import Article
+from readability.readable import Article
 
 
 class TestAntipopeBlog(unittest.TestCase):

tests/test_articles/test_scripting-com/test.py

@@ -7,9 +7,9 @@ except ImportError:
     import unittest
 
 
-from breadability.readable import Article
+from readability.readable import Article
-from breadability.readable import check_siblings
+from readability.readable import check_siblings
-from breadability.readable import prep_article
+from readability.readable import prep_article
 
 
 class TestArticle(unittest.TestCase):

tests/test_orig_document.py

@@ -9,8 +9,8 @@ except ImportError:
     import unittest
 
 from collections import defaultdict
-from breadability._py3k import to_unicode, to_bytes
+from readability._py3k import to_unicode, to_bytes
-from breadability.document import OriginalDocument, determine_encoding
+from readability.document import OriginalDocument, determine_encoding
 from .utils import load_snippet
 
 

tests/test_readable.py

@@ -10,14 +10,14 @@ try:
 except ImportError:
     import unittest
 
-from breadability._py3k import to_unicode
+from readability._py3k import to_unicode
-from breadability.readable import Article
+from readability.readable import Article
-from breadability.readable import get_class_weight
+from readability.readable import get_class_weight
-from breadability.readable import get_link_density
+from readability.readable import get_link_density
-from breadability.readable import is_bad_link
+from readability.readable import is_bad_link
-from breadability.readable import score_candidates
+from readability.readable import score_candidates
-from breadability.readable import leaf_div_elements_into_paragraphs
+from readability.readable import leaf_div_elements_into_paragraphs
-from breadability.scoring import ScoredNode
+from readability.scoring import ScoredNode
 from .utils import load_snippet, load_article
 
 

tests/test_scoring.py

@@ -13,15 +13,15 @@ try:
 except ImportError:
     import unittest
 
-from breadability._py3k import to_unicode
+from readability._py3k import to_unicode
-from breadability.readable import Article
+from readability.readable import Article
-from breadability.scoring import check_node_attributes
+from readability.scoring import check_node_attributes
-from breadability.scoring import get_class_weight
+from readability.scoring import get_class_weight
-from breadability.scoring import ScoredNode
+from readability.scoring import ScoredNode
-from breadability.scoring import score_candidates
+from readability.scoring import score_candidates
-from breadability.scoring import generate_hash_id
+from readability.scoring import generate_hash_id
-from breadability.readable import get_link_density
+from readability.readable import get_link_density
-from breadability.readable import is_unlikely_node
+from readability.readable import is_unlikely_node
 from .utils import load_snippet