CLN: Clean docstrings, remove EDGAR

Author: addisonlynch

.coveragerc

@@ -6,11 +6,10 @@ include = */pandas_datareader/*
 omit =
     */_version.py
     */yahoo/*
-    */edgar.py
     */google/options.py
     */google/quotes.py
     */tests/google/test_options.py
-    */tests/test_edgar.py
+
 
 [report]
 # Regexes for lines to exclude from consideration
@@ -26,9 +25,7 @@ include = */pandas_datareader/*
 omit =
     */_version.py
     */yahoo/*
-    */edgar.py
     */google/options.py
     */google/quotes.py
     */tests/google/test_options.py
-    */tests/test_edgar.py
 ignore_errors = True

docs/source/whatsnew/v0.7.0.txt

@@ -11,6 +11,7 @@ v0.7.0 (Xxxxxxx YY, 20ZZ)
 Highlights include:
 
 - Immediate deprecation of Google finance and Morningstar for historical price data, as these API endpoints are no longer supported by their respective providers. Alternate methods are welcome via pull requests, as PDR would like to restore these features.
+- Removal of EDGAR, which was deprecated in v0.6.0.
 
 .. contents:: What's new in v0.7.0
     :local:
@@ -65,10 +66,7 @@ Bug Fixes
 
 - Added support for passing the API KEY to QuandlReader either directly or by
   setting the environmental variable QUANDL_API_KEY (:issue:`485`).
-- Handle Morningstar index volume data properly (:issue:`486`).
 - Added support for optionally passing a custom base_url to the EnigmaReader  (:issue:`499`).
-- Fixed Morningstar 'retry' incrementation (:issue:`513`)
-- Updated Google Daily Price API to functional url (:issue:`502`)
 - Fix Yahoo! price data (:issue:`498`)
 - Added back support for Yahoo! price, dividends, and splits data for stocks
   and currency pairs (:issue:`487`).

pandas_datareader/av/__init__.py

@@ -19,7 +19,7 @@ class AlphaVantage(_BaseReader):
     _format = 'json'
 
     def __init__(self, symbols=None, start=None, end=None, retry_count=3,
-                 pause=0.001, session=None, api_key=None):
+                 pause=0.1, session=None, api_key=None):
         super(AlphaVantage, self).__init__(symbols=symbols, start=start,
                                            end=end, retry_count=retry_count,
                                            pause=pause, session=session)

pandas_datareader/av/forex.py

@@ -27,7 +27,7 @@ class AVForexReader(AlphaVantage):
         Alpha Vantage API key . If not provided the environmental variable
         ALPHAVANTAGE_API_KEY is read. The API key is *required*.
     """
-    def __init__(self, symbols=None, retry_count=3, pause=0.5, session=None,
+    def __init__(self, symbols=None, retry_count=3, pause=0.1, session=None,
                  api_key=None):
 
         super(AVForexReader, self).__init__(symbols=symbols,

pandas_datareader/av/quotes.py

@@ -22,7 +22,7 @@ class AVQuotesReader(AlphaVantage):
     session : Session, default None
         requests.sessions.Session instance to be used
     """
-    def __init__(self, symbols=None, retry_count=3, pause=0.5, session=None,
+    def __init__(self, symbols=None, retry_count=3, pause=0.1, session=None,
                  api_key=None):
         if isinstance(symbols, str):
             syms = [symbols]

pandas_datareader/av/time_series.py

@@ -39,7 +39,7 @@ class AVTimeSeriesReader(AlphaVantage):
     }
 
     def __init__(self, symbols=None, function="TIME_SERIES_DAILY",
-                 start=None, end=None, retry_count=3, pause=0.35,
+                 start=None, end=None, retry_count=3, pause=0.1,
                  session=None, chunksize=25, api_key=None):
         super(AVTimeSeriesReader, self).__init__(symbols=symbols, start=start,
                                                  end=end,

pandas_datareader/base.py

@@ -192,7 +192,7 @@ class _DailyBaseReader(_BaseReader):
     """ Base class for Google / Yahoo daily reader """
 
     def __init__(self, symbols=None, start=None, end=None, retry_count=3,
-                 pause=0.001, session=None, chunksize=25):
+                 pause=0.1, session=None, chunksize=25):
         super(_DailyBaseReader, self).__init__(symbols=symbols,
                                                start=start, end=end,
                                                retry_count=retry_count,

pandas_datareader/data.py

@@ -9,7 +9,6 @@
 from pandas_datareader.av.sector import AVSectorPerformanceReader
 from pandas_datareader.av.time_series import AVTimeSeriesReader
 from pandas_datareader.bankofcanada import BankOfCanadaReader
-from pandas_datareader.edgar import EdgarIndexReader
 from pandas_datareader.enigma import EnigmaReader
 from pandas_datareader.eurostat import EurostatReader
 from pandas_datareader.exceptions import DEP_ERROR_MSG, \
@@ -255,7 +254,7 @@ def get_iex_book(*args, **kwargs):
 
 
 def DataReader(name, data_source=None, start=None, end=None,
-               retry_count=3, pause=0.001, session=None, access_key=None):
+               retry_count=3, pause=0.1, session=None, access_key=None):
     """
     Imports data from a number of online sources.
 
@@ -368,11 +367,6 @@ def DataReader(name, data_source=None, start=None, end=None,
         return EurostatReader(symbols=name, start=start, end=end,
                               retry_count=retry_count, pause=pause,
                               session=session).read()
-    elif data_source == "edgar-index":
-        raise ImmediateDeprecationError(DEP_ERROR_MSG.format('EDGAR'))
-        return EdgarIndexReader(symbols=name, start=start, end=end,
-                                retry_count=retry_count, pause=pause,
-                                session=session).read()
     elif data_source == 'nasdaq':
         if name != 'symbols':
             raise ValueError("Only the string 'symbols' is supported for "

pandas_datareader/edgar.py

@@ -32,7 +32,7 @@ class GoogleDailyReader(_DailyBaseReader):
     """
 
     def __init__(self, symbols=None, start=None, end=None, retry_count=3,
-                 pause=0.001, session=None, chunksize=25):
+                 pause=0.1, session=None, chunksize=25):
         raise ImmediateDeprecationError(DEP_ERROR_MSG.format('Google finance'))
         super(GoogleDailyReader, self).__init__(symbols, start, end,
                                                 retry_count, pause, session,