aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorIzidor Matušov <izidor.matusov@gmail.com>2014-02-08 00:42:59 +0000
committerMatěj Cepl <mcepl@redhat.com>2014-02-08 10:39:51 +0100
commit5fa125289e217e172c4875ac310734492170ba31 (patch)
tree2b4bd1b781dfb1962181a3e71df739ea702ce473 /README.rst
parent2c734aeadf108363e570f59b4a69adbe14835171 (diff)
downloadgg_scraper-5fa125289e217e172c4875ac310734492170ba31.tar.gz
Clean up README
Allow simple copy'n'paste for usage
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst26
1 files changed, 20 insertions, 6 deletions
diff --git a/README.rst b/README.rst
index 7727864..75aff16 100644
--- a/README.rst
+++ b/README.rst
@@ -1,8 +1,27 @@
+=====================
+Google Group Scrapper
+=====================
+
+.. image:: https://secure.travis-ci.org/mcepl/gg_scraper.png
+ :alt: Build Status
+
A small script as a replacement of `the old PHP script`_ for downloading messages stored in the black hole of the Google Groups.
.. _`the old PHP script`:
http://saturnboy.com/2010/03/scraping-google-groups/
+How to use it?
+--------------
+
+::
+
+ sudo apt-get install procmail
+ pip install beautifulsoup4 PyYAML
+ python gg_scraper.py 'https://groups.google.com/forum/#!forum/<group_name>'
+
+Background
+----------
+
I would never start without an inspiration from the comment_ on my previous post on the theme of locked down nature of Google Groups.
.. _comment:
@@ -16,9 +35,4 @@ email (one of many of my addresses are available on my `Github page`_ )
.. _`Github page`:
https://github.com/mcepl
-Of course pull requests are more than welcome in the same places as
-well. Currently all development is done with Python 3.3, but tests are
-run on Travis-CI for 2.6, 2.7, and pypy as well.
-
-.. image:: https://secure.travis-ci.org/mcepl/gg_scraper.png
- :alt: Build Status
+Of course pull requests are more than welcome in the same places as well. Currently all development is done with Python 3.3, but tests are run on Travis-CI for 2.7 and pypy as well.