From f4fa0c104027a6e7f648d1cc957067763873e325 Mon Sep 17 00:00:00 2001 From: Richard Harding Date: Fri, 29 Nov 2013 12:21:22 -0500 Subject: [PATCH] Working on merging/updating changelog, news, and makefile --- CHANGELOG.rst | 26 +++++++++- Makefile | 2 +- NEWS.txt | 140 -------------------------------------------------- README.rst | 20 ++++---- setup.py | 4 +- 5 files changed, 38 insertions(+), 154 deletions(-) delete mode 100644 NEWS.txt diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 24af104..c9c2554 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,16 +2,40 @@ Changelog for readability ========================== + +0.1.15 (Nov 29th 2013) +----------------------- + +Merge changes from 0.1.14 of breadability with the fork +https://github.com/miso-belica/readability.py and tweaking to return to the +name breadability. + + +From the fork +~~~~~~~~~~~~~~ - Added property ``Article.main_text`` for getting text annotated with semantic HTML tags (, , ...). - Join node with 1 child of the same type. From ``
...
`` we get ``
...
``. - Don't change
to

if it contains

elements. - Renamed test generation helper 'readability_newtest' -> 'readability_test'. -- Renamed package to readability. +- Renamed package to readability. (Renamed back) - Added support for Python >= 3.2. - Py3k compatible package 'charade' is used instead of 'chardet'. +0.1.14 (Nov 7th 2013) +---------------------- +- Update sibling append to only happen when sibling doesn't already exist. + +0.1.13 (Aug 31st 2013) +----------------------- +- Give images in content boy a better chance of survival +- Add tests + +0.1.12 (July 28th 2013) +----------------------- +- Add a user agent to requests. + 0.1.11 (Dec 12th 2012) ----------------------- - Add argparse to the install requires for python < 2.7 diff --git a/Makefile b/Makefile index e33b31c..e7cbf54 100644 --- a/Makefile +++ b/Makefile @@ -62,4 +62,4 @@ upload: .PHONY: version_update version_update: - $(EDITOR) setup.py NEWS.txt + $(EDITOR) setup.py CHANGELOG.rst diff --git a/NEWS.txt b/NEWS.txt deleted file mode 100644 index e8df611..0000000 --- a/NEWS.txt +++ /dev/null @@ -1,140 +0,0 @@ -.. 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.1.14 -------- -* Release date: Nov 7th 2013 - -* Update sibling append to only happen when sibling doesn't already exist. - -0.1.13 ------- - -* Release date: Aug 31th 2013* - -* Give images in content boy a better chance of survival -* Add tests - - -0.1.12 -------- - -* Release date: July 28th 2013* - -* Add a user agent to requests. - - -0.1.11 -------- - -* Release date: Dec 12th 2012* - -* Add argparse to the install requires for python < 2.7 - - - -0.1.10 -------- - -* Release date: Sept 13th 2012* - -* Updated scoring bonus and penalty with , and " characters. - - -0.1.9 ------- - -* Release date: Aug 27nd 2012* - -* In case of an issue dealing with candidates we need to act like we didn't - find any candidates for the article content. #10 - - -0.1.8 ------- - -* Release date: Aug 27nd 2012* - -* Add code/tests for an empty document. -* Fixes #9 to handle xml parsing issues. - - - -0.1.7 ------- - -* Release date: July 21nd 2012* - -* Change the encode 'replace' kwarg into a normal arg for older python - version. - - - -0.1.6 ------- - -* Release date: June 17th 2012* - -* Fix the link removal, add tests and a place to process other bad links. - - - -0.1.5 ------- - -* Release date: June 16th 2012* - -* Start to look at removing bad links from content in the conditional cleaning - state. This was really used for the scripting.com site's garbage. - - - -0.1.4 ------- - -* Release date: June 16th 2012* - -* Add a test generation helper breadability_newtest script. -* Add tests and fixes for the scripting news parse failure. - - -0.1.3 ------- - -* Release date: June 15th 2012* - -* Add actual testing of full articles for regression tests. -* Update parser to properly clean after winner doc node is chosen. - - -0.1.2 ------- - -* Release date: May 28th 2012* - -* Bugfix: #4 issue with logic of the 100char bonus points in scoring -* Garden with PyLint/PEP8 -* Add a bunch of tests to readable/scoring code. - - -0.1.1 ------- - -* Release date: May 11th 2012* - -* Fix bugs in scoring to help in getting right content -* Add concept of -d which shows scoring/decisions on nodes -* Update command line client to be able to pipe output to other tools - - -0.1.0 ---- - -*Release date: May 6th 2012* - -* Initial release and upload to PyPi diff --git a/README.rst b/README.rst index 495c1e4..21d6efc 100644 --- a/README.rst +++ b/README.rst @@ -1,14 +1,14 @@ Readability.py - another readability Python port -============================================== -.. image:: https://api.travis-ci.org/miso-belica/readability.py.png?branch=master - :target: https://travis-ci.org/miso-belica/readability.py +================================================= +.. image:: https://api.travis-ci.org/bookieio/breadability.png?branch=master + :target: https://travis-ci.org/bookieio/breadability.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 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. +code base, 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, @@ -45,14 +45,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/readability.py.git + $ [sudo] pip install git+git://github.com/bookieio/breadability.git Tests ----- .. code-block:: bash - $ nosetests --with-coverage --cover-package=readability --cover-erase tests - $ nosetests-3.3 --with-coverage --cover-package=readability --cover-erase tests + $ nosetests --with-coverage --cover-package=breadability --cover-erase tests + $ nosetests-3.3 --with-coverage --cover-package=breadability --cover-erase tests Usage @@ -62,7 +62,7 @@ Command line .. code-block:: bash - $ readability http://wiki.python.org/moin/BeginnersGuide + $ breadability http://wiki.python.org/moin/BeginnersGuide Options ``````` @@ -84,7 +84,7 @@ Python API from __future__ import print_function - from readability.readable import Article + from breadability.readable import Article if __name__ == "__main__": @@ -102,7 +102,7 @@ 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 +- http://r.bmark.us so I really need this to be an active and improving project. diff --git a/setup.py b/setup.py index 046e3a6..bdb0dac 100644 --- a/setup.py +++ b/setup.py @@ -30,9 +30,9 @@ if sys.version_info < (2, 7): console_script_targets = [ "readability = readability.scripts.client:main", - "readability-{} = readability.scripts.client:main", + "readability-{0} = readability.scripts.client:main", "readability_test = readability.scripts.test_helper:main", - "readability_test-{} = readability.scripts.test_helper:main", + "readability_test-{0} = readability.scripts.test_helper:main", ] console_script_targets = [ target.format(VERSION_SUFFIX) for target in console_script_targets