use ReStructuredText for README instead of markdown

Author: grangier

README.md README.rstREADME.md renamed to README.rst

@@ -1,46 +1,59 @@
-#Python-Goose - Article Extractor [![Build Status](https://www.travis-ci.org/xgdlm/python-goose.png?branch=master)](https://www.travis-ci.org/xgdlm/python-goose)
+Python-Goose - Article Extractor |Build Status|
+===============================================
 
-##Intro
+Intro
+-----
 
+Goose was originally an article extractor written in Java that has most
+recently (aug2011) converted to a scala project by Gravity.com
 
-Goose was originally an article extractor written in Java that has most recently (aug2011) converted to a scala project by Gravity.com
-
-This is a complete rewrite in python. The aim of the software is is to take any news article or article type web page and not only extract what is the main body of the article but also all meta data and most probable image candidate.
+This is a complete rewrite in python. The aim of the software is is to
+take any news article or article type web page and not only extract what
+is the main body of the article but also all meta data and most probable
+image candidate.
 
 Goose will try to extract the following information:
 
- - Main text of an article
- - Main image of article
- - Any Youtube/Vimeo movies embedded in article (TODO)
- - Meta Description
- - Meta tags
-
+-  Main text of an article
+-  Main image of article
+-  Any Youtube/Vimeo movies embedded in article (TODO)
+-  Meta Description
+-  Meta tags
 
 Originally, Goose was open sourced by Gravity.com in 2011
 
- - Lead Programmer: Jim Plush (Gravity.com)
- - Contributers: Robbie Coleman (Gravity.com)
+-  Lead Programmer: Jim Plush (Gravity.com)
+-  Contributers: Robbie Coleman (Gravity.com)
 
 The python version was rewrite by:
 
- - Xavier Grangier (Recrutae.com)
+-  Xavier Grangier (Recrutae.com)
+
+Licensing
+---------
+
+If you find Goose useful or have issues please drop me a line, I'd love
+to hear how you're using it or what features should be improved
 
-##Licensing
-If you find Goose useful or have issues please drop me a line, I'd love to hear how you're using it or what features should be improved
+Goose is licensed by Gravity.com under the Apache 2.0 license, see the
+LICENSE file for more details
 
-Goose is licensed by Gravity.com under the Apache 2.0 license, see the LICENSE file for more details
+Setup
+-----
+
+::
 
-##Setup
     mkvirtualenv --no-site-packages goose
     git clone https://github.com/grangier/python-goose.git
     cd python-goose
     pip install -r requirements.txt
     python setup.py install
-    
-    
-    
 
-##Take it for a spin
+Take it for a spin
+------------------
+
+::
+
     >>> from goose import Goose
     >>> url = 'http://edition.cnn.com/2012/02/22/world/europe/uk-occupy-london/index.html?hpt=ieu_c2'
     >>> g = Goose()
@@ -54,23 +67,35 @@ Goose is licensed by Gravity.com under the Apache 2.0 license, see the LICENSE f
     >>> article.top_image.src
     http://i2.cdn.turner.com/cnn/dam/assets/111017024308-occupy-london-st-paul-s-cathedral-story-top.jpg
 
+Configuration
+-------------
 
-##Configuration
-There is two way to pass configuration to goose. The first one is to pass to goose a Configuration() object. The second one is to pass a configuration dict
+There is two way to pass configuration to goose. The first one is to
+pass to goose a Configuration() object. The second one is to pass a
+configuration dict
 
-For instance, if you want to change the userAgent used by Goose juste pass :
+For instance, if you want to change the userAgent used by Goose juste
+pass :
+
+::
 
     >>> g = Goose({'browser_user_agent': 'Mozilla'})
 
+Switching parser : Goose can now be use with lxml html parser or lxml
+soup parser. By default the html parser is used. If you want to use the
+soup parser passe it in the configuration dict :
 
-Switching parser :
-Goose can now be use with lxml html parser or lxml soup parser. By default the html parser is used. If you want to use the soup parser passe it in the configuration dict :
+::
 
     >>> g = Goose({'browser_user_agent': 'Mozilla', 'parser_class':'soup'})
 
+Goose is now language aware
+---------------------------
+
+For exemple scrapping a spanish content page with correct meta language
+tags
 
-##Goose is now language aware
-For exemple scrapping a spanish content page with correct meta language tags
+::
 
     >>> from goose import Goose
     >>> url = 'http://sociedad.elpais.com/sociedad/2012/10/27/actualidad/1351332873_157836.html'
@@ -81,7 +106,10 @@ For exemple scrapping a spanish content page with correct meta language tags
     >>> article.cleaned_text[:150]
     u'Los recortes pasan factura a los pacientes. De diciembre de 2010 a junio de 2012 las listas de espera para operarse aumentaron un 125%. Hay m\xe1s ciudad'
 
-Some pages don't have correct meta language tags, you can force it using configuration :
+Some pages don't have correct meta language tags, you can force it using
+configuration :
+
+::
 
     >>> from goose import Goose
     >>> url = 'http://www.elmundo.es/elmundo/2012/10/28/espana/1351388909.html'
@@ -90,14 +118,18 @@ Some pages don't have correct meta language tags, you can force it using configu
     >>> article.cleaned_text[:150]
     u'Importante golpe a la banda terrorista ETA en Francia. La Guardia Civil ha detenido en un hotel de Macon, a 70 kil\xf3metros de Lyon, a Izaskun Lesaka y '
 
-Passing 
-    {'use_meta_language': False, 'target_language':'es'}
-will force as configuration will force the spanish language
+Passing {'use\_meta\_language': False, 'target\_language':'es'} will
+force as configuration will force the spanish language
 
+Goose in Chinese
+----------------
 
+Some users want to use Goose for chinese content. Chinese word
+segementation is way more difficult to deal with that occidental
+languages. Chinese needs a dedicated StopWord analyser that need to be
+passed to the config object
 
-##Goose in Chinese
-Some users want to use Goose for chinese content. Chinese word segementation is way more difficult to deal with that occidental languages. Chinese needs a dedicated StopWord analyser that need to be passed to the config object
+::
 
     >>> from goose import Goose
     >>> from goose.text import StopWordsChinese
@@ -111,10 +143,13 @@ Some users want to use Goose for chinese content. Chinese word segementation is
 
     一些亲北京阵营议员欢迎梁振英道歉，且认为应能获得香港民众接受，但这些议员也质问梁振英有
 
+Goose in Arabic
+---------------
 
+In order to use Goose in Arabic you have to use the StopWordsArabic
+class.
 
-##Goose in Arabic
-In order to use Goose in Arabic you have to use the StopWordsArabic class.
+::
 
     >>> from goose import Goose
     >>> from goose.text import StopWordsArabic
@@ -124,38 +159,52 @@ In order to use Goose in Arabic you have to use the StopWordsArabic class.
     >>> print article.cleaned_text[:150]
     دمشق، سوريا (CNN) -- أكدت جهات سورية معارضة أن فصائل مسلحة معارضة لنظام الرئيس بشار الأسد وعلى صلة بـ"الجيش الحر" تمكنت من السيطرة على مستودعات للأسل
 
+TODO
+----
+
+-  Video extraction
 
-##TODO
-  - Video extraction
+Known issues
+------------
 
-##Known issues
-  - There is some issue with unicode URLs.
+-  There is some issue with unicode URLs.
 
-##OS X 10.7 Install Instructions
+OS X 10.7 Install Instructions
+------------------------------
 
 Installation Help:
 
 1. Install python-devel if you don't have it
-2. Install libjpeg
-        brew install libjpeg
+2. Install libjpeg brew install libjpeg
+
+3. You need to install the python imaging library. We wont be using it,
+   but its a dependency deep in the goose egg (fun!).
+
+a. download
+
+   ::
 
-3. You need to install the python imaging library.  We wont be using it, but its a dependency deep in the goose egg (fun!).
+       curl -O -L http://effbot.org/downloads/Imaging-1.1.7.tar.gz
 
-  a. download
+b. extract
 
-        curl -O -L http://effbot.org/downloads/Imaging-1.1.7.tar.gz
+   ::
 
-  b. extract
+       tar -xzf Imaging-1.1.7.tar.gz
+       cd Imaging-1.1.7
 
-        tar -xzf Imaging-1.1.7.tar.gz
-        cd Imaging-1.1.7
+c. build and install
 
-  c. build and install
+   ::
 
-        python setup.py build
-        sudo python setup.py install
+       python setup.py build
+       sudo python setup.py install
 
 4. Next up clone this repo and install the egg.
 
-5. Once you install the egg you have to then copy the resources directory manually into the egg.  There is something screwy about the way its setup.
+5. Once you install the egg you have to then copy the resources
+   directory manually into the egg. There is something screwy about the
+   way its setup.
 
+.. |Build Status| image:: https://www.travis-ci.org/xgdlm/python-goose.png?branch=master
+   :target: https://www.travis-ci.org/xgdlm/python-goose

setup.py

@@ -48,7 +48,7 @@
 
 # read long description
 try:
-    with open(os.path.join(os.path.dirname(__file__), 'README.md')) as f:
+    with open(os.path.join(os.path.dirname(__file__), 'README.rst')) as f:
         long_description = f.read()
 except:
     long_description = description