- Clarified usage

- fixed version string in cli.py
- removed redundant path in dcs/conf.py
- updated .bumpversion.cfg to automatically update the cli version

.bumpversion.cfg

@@ -11,3 +11,6 @@ replace = version='{new_version}'
 search = __version__ = '{current_version}'
 replace = __version__ = '{new_version}'
 
+[bumpversion:file:sec_edgar_download/cli.py]
+search = version='sec_edgar_download {current_version}'
+replace = version='sec_edgar_download {new_version}'

HISTORY.rst

@@ -4,10 +4,21 @@ History
 0.0.2 (2017-01-30)
 ------------------
 
-* First release to PyPi test
+* First release to PyPi test.
 
 
 0.1.0 (2017-01-30)
 ------------------
 
-* First release to PyPi
+* First release to PyPi.
+
+0.1.1 (2017-05-30)
+------------------
+
+* Second release to PyPi Added the -f flag to  the getxbrl command to specify
+  a file containing tickers.
+
+0.1.2 (2017-08-16)
+------------------
+
+* Added some more usage documentation.

README.rst

@@ -73,6 +73,9 @@ Usage Examples
 
 From the command line.
 
+- Firstly download the rss feeds, these get added to a local database
+- Next specify which tickers to download the xbrl filings for.
+
 .. code:: bash
 
 	pip install sec_edgar_download

docs/conf.py

@@ -27,7 +27,6 @@
 project_root = os.path.dirname(cwd)
 
 sys.path.insert(0, project_root)
-sys.path.insert(0, os.path.abspath('sec_edgar_download'))
 
 import sec_edgar_download
 

docs/modules.rst

@@ -0,0 +1,8 @@
+sec_edgar_download.indexer module
+---------------------------------
+
+.. automodule:: sec_edgar_download.indexer
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

sec_edgar_download/cli.py

@@ -33,7 +33,7 @@
 
 
 def main(args=None):
-    arguments = docopt(__doc__, version='sec_edgar_download 0.0.0')
+    arguments = docopt(__doc__, version='sec_edgar_download 0.1.2')
     print(arguments)
 
     from_year = int(arguments['<from-year>'])

sec_edgar_download/indexer.py

@@ -186,7 +186,7 @@ def _download_sec_feed(self, year, month):
 
         Args:
             year (int); The year of the feed
-            month (int); The year of the feed
+            month (int); The month of the feed
 
         Returns:
             feed_file (str): The location of the downloaded RSS file.