Permalink
Browse files

more renaming and doc update

  • Loading branch information...
1 parent b5a6ff1 commit d22396a510d9ccf88f43a17bee09f7e0737c9afd @niklasb committed Jan 13, 2012
Showing with 32 additions and 24 deletions.
  1. +9 −9 docs/apidoc.rst
  2. +12 −4 docs/index.rst
  3. +8 −8 docs/installation.rst
  4. +3 −3 docs/usage.rst
View
@@ -8,27 +8,27 @@ for it).
Overview
----------
-.. inheritance-diagram:: pyscrape.session
- pyscrape.mixins
- pyscrape.driver.webkit
+.. inheritance-diagram:: dryscrape.session
+ dryscrape.mixins
+ dryscrape.driver.webkit
webkit_server
-Module :mod:`pyscrape.session`
+Module :mod:`dryscrape.session`
-------------------------------
-.. automodule:: pyscrape.session
+.. automodule:: dryscrape.session
:members:
-Module :mod:`pyscrape.mixins`
+Module :mod:`dryscrape.mixins`
-------------------------------
-.. automodule:: pyscrape.mixins
+.. automodule:: dryscrape.mixins
:members:
-Module :mod:`pyscrape.driver.webkit`
+Module :mod:`dryscrape.driver.webkit`
-------------------------------------
-.. automodule:: pyscrape.driver.webkit
+.. automodule:: dryscrape.driver.webkit
:members:
Module :mod:`webkit_server`
View
@@ -1,11 +1,19 @@
-Welcome to pyscrape's documentation!
+Welcome to dryscrape's documentation!
====================================
-pyscrape is a lightweight web scraping framework for Python.
-It uses a headless Webkit instance to evaluate Javascript on the
-visited pages. This enables scraping of Javascript-heavy "Web 2.0" pages like
+dryscrape is a lightweight web scraping library for Python. It uses a
+headless Webkit instance to evaluate Javascript on the visited pages. This
+enables painless scraping of plain web pages as well as Javascript-heavy
+“Web 2.0” applications like
Facebook.
+It is built on the shoulders of
+[capybara-webkit](https://github.com/thoughtbot/capybara-webkit)'s
+[webkit-server](https://github.com/niklasb/webkit-server).
+
+A big thanks goes to thoughtbot, inc. for this excellent piece of
+software!
+
Contents
----------
View
@@ -3,20 +3,20 @@
Installation
============
-First, get a copy of pyscrape_ using Git:
+First, get a copy of dryscrape_ using Git:
::
- $ git clone https://github.com/niklasb/pyscrape.git pyscrape
- $ cd pyscrape
+ $ git clone https://github.com/niklasb/dryscrape.git dryscrape
+ $ cd dryscrape
-To install pyscrape, you first need to install its dependencies. These are:
+To install dryscrape, you first need to install its dependencies. These are:
* lxml_
* webkit-server_
You can use pip_ to do this for you (while still in
-the pyscrape directory). The ``#`` indicates that you need root privileges for
+the dryscrape directory). The ``#`` indicates that you need root privileges for
this:
::
@@ -25,16 +25,16 @@ this:
If you want, you can of course also install the dependencies manually.
-Afterwards, you can use the ``setup.py`` script included to install pyscrape:
+Afterwards, you can use the ``setup.py`` script included to install dryscrape:
::
# python setup.py install
-Note that pyscrape is written for Python 2.7+, so make sure that you use both the
+Note that dryscrape is written for Python 2.7+, so make sure that you use both the
``python`` and ``pip`` commands in the right version.
.. _lxml: http://lxml.de/
.. _webkit-server: https://github.com/niklasb/webkit-server/
.. _pip: http://pypi.python.org/pypi/pip
-.. _pyscrape: https://github.com/niklasb/pyscrape/
+.. _dryscrape: https://github.com/niklasb/dryscrape/
View
@@ -8,9 +8,9 @@ A code sample tells more than thousand words:
.. literalinclude:: /../examples/google.py
-In this sample, we use pyscrape to do a simple web search on Google.
-Note that we set up a Webkit driver instance here and pass it to a pyscrape
-:py:class:`~pyscrape.session.Session` in the constructor. The session instance
+In this sample, we use dryscrape to do a simple web search on Google.
+Note that we set up a Webkit driver instance here and pass it to a dryscrape
+:py:class:`~dryscrape.session.Session` in the constructor. The session instance
then passes every method call it cannot resolve -- such as
:py:meth:`~webkit_server.CommandsMixin.visit`, in this case -- to the
underlying driver.

0 comments on commit d22396a

Please sign in to comment.