docstring updates, version 0.2.2

grapple/__init__.py

@@ -7,7 +7,7 @@
     pass
 
 __title__      = "grapple"
-__version__    = "0.2.1"
+__version__    = "0.2.2"
 __author__     = "Jack Peterson"
 __license__    = "MIT"
 __maintainer__ = "Jack Peterson"

grapple/grapple.py

@@ -1,5 +1,5 @@
 #!/usr/bin/env python
-"""Download the Ripple ledger from rippled.
+"""Ripple ledger extractor.
 
 Grapple extracts the ledger from rippled via websocket.  It starts at the
 current ledger index, and walks backwards until it reaches the genesis ledger.
@@ -9,21 +9,22 @@
 current ledger to the maximum ledger index previously recorded.  Just set
 the "full" flag if you prefer to re-download the entire ledger.
 
-Grapple can collect data from a local or remote rippled instance.  If you have
+Data can be collected from a local or a remote rippled instance.  If you have
 a local rippled instance running that has downloaded all or most of the ledger,
 I strongly recommend doing local data collection.  Fetching data from Ripple's
 public websocket is very slow!
 
-Also resamples the transaction time series to create "Open-Hi-Lo-Close" data,
-which can be useful for statistical tests, or simply for drawing charts.
+Grapple also resamples each currency pair's price time series to create
+"Open-Hi-Lo-Close" time series.  These resampled datasets can be useful for
+statistical tests, technical market analysis, or simply for drawing charts.
 
 Grapple is designed to integrate with PostgreSQL, using connection information
 in config.py.  By default, it assumes that your database is located on
-localhost (127.0.0.1), and that your database username, password, and password
+localhost (127.0.0.1), and that your database's name, password, username and
 are all "grapple".
 
-(While this is certainly not the most secure setup, it may be convenient for
-people who install Grapple via pip, and do not wish to edit its source code.)
+(While this is certainly not a secure setup, it may be convenient for people
+who install Grapple via pip, and do not wish to edit its source code.)
 
 Usage as a Python module:
 
@@ -44,7 +45,7 @@
         (default=True)
 
     genesis (int):
-        Genesis ledger index; download halting point. (default=152370)
+        Genesis ledger index and download halting point. (default=152370)
     
     quiet (bool):
         If True, suppress console output. (default=True)
@@ -69,7 +70,7 @@
         Download the full Ripple ledger.  Automatic on first run.
 
     -g, --genesis [ledger index]:
-        Halting point for full downloads; ignored for partial downloads.
+        Genesis ledger index and download halting point.
 
     -q, --quiet:
         Suppress command line output.

setup.py

@@ -6,15 +6,15 @@
 
 setup(
     name="grapple",
-    version="0.2.1",
+    version="0.2.2",
     description="Ripple ledger extractor",
     author="Jack Peterson",
     author_email="<jack@tinybike.net>",
     maintainer="Jack Peterson",
     maintainer_email="<jack@tinybike.net>",
     license="MIT",
     url="https://github.com/tensorjack/grapple",
-    download_url = 'https://github.com/tensorjack/grapple/tarball/0.2.1',
+    download_url = "https://github.com/tensorjack/grapple/tarball/0.2.2",
     packages=["grapple"],
     install_requires=["psycopg2", "websocket-client", "numpy", "pandas"],
     keywords = ["ripple", "rippled", "ledger", "download", "data"]