Merge pull request #609 from addisonlynch/depr-robinhood-api

CLN/REF: Mark deprecated Robinhood API

Author: bashtage

docs/source/readers/index.rst

@@ -16,7 +16,6 @@ Data Readers
    nasdaq-trader
    oecd
    quandl
-   robinhood
    stooq
    tiingo
    tsp

docs/source/remote_data.rst

@@ -21,6 +21,11 @@ Remote Data Access
 
   Yahoo! Finance, Google Finance, and Morningstar have been immediately deprecated.  Endpoints from these providers have been retired
 
+.. warning::
+
+    Robinhood has been immediately deprecated. Endpoints from this provider
+    have been retired.
+
 .. _remote_data.data_reader:
 
 Functions from :mod:`pandas_datareader.data` and :mod:`pandas_datareader.wb`
@@ -29,7 +34,6 @@ Currently the following sources are supported:
 
     - :ref:`Tiingo<remote_data.tiingo>`
     - :ref:`IEX<remote_data.iex>`
-    - :ref:`Robinhood<remote_data.robinhood>`
     - :ref:`Alpha Vantage<remote_data.alphavantage>`
     - :ref:`Enigma<remote_data.enigma>`
     - :ref:`Quandl<remote_data.quandl>`
@@ -94,21 +98,6 @@ A third interface to the deep API is exposed through
     f[:10]
 
 
-.. _remote_data.robinhood:
-
-Robinhood
-=========
-`Robinhood <https://www.robinhood.com>`__ is a stock trading platform with an
-API that provides a limited set of data. Historical daily data is limited to 1
-year relative to today.
-
-.. ipython:: python
-
-    import pandas_datareader.data as web
-    from datetime import datetime
-    f = web.DataReader('F', 'robinhood')
-    f.head()
-
 .. _remote_data.alphavantage:
 
 Alpha Vantage

docs/source/whatsnew/v0.8.0.txt

@@ -5,6 +5,9 @@ v0.8.0 (TBD)
 
 Highlights include:
 
+- Immediate deprecation of Robinhood for quotes and historical data. Robinhood
+  ended support for these endpoints in 1/2019
+
 .. contents:: What's new in v0.8.0
     :local:
     :backlinks: none
@@ -20,6 +23,9 @@ Enhancements
 Backwards incompatible API changes
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+- Immediate deprecation of Robinhood for quotes and historical data. Robinhood
+  ended support for these endpoints in 1/2019. The Robinhood quotes and daily
+  readers will raise an ``ImmediateDeprecationError`` when called.
 
 
 .. _whatsnew_080.bug_fixes:

pandas_datareader/robinhood.py

@@ -1,12 +1,17 @@
 import pandas as pd
 
 from pandas_datareader.base import _BaseReader
+from pandas_datareader.exceptions import (ImmediateDeprecationError,
+                                          DEP_ERROR_MSG)
 
 
 class RobinhoodQuoteReader(_BaseReader):
     """
     Read quotes from Robinhood
 
+    DEPRECATED 1/2019 - Robinhood ended support for the endpoints used by this
+    reader
+
     Parameters
     ----------
     symbols : {str, List[str]}
@@ -28,6 +33,7 @@ class RobinhoodQuoteReader(_BaseReader):
 
     def __init__(self, symbols, start=None, end=None, retry_count=3, pause=.1,
                  timeout=30, session=None, freq=None):
+        raise ImmediateDeprecationError(DEP_ERROR_MSG.format("Robinhood"))
         super(RobinhoodQuoteReader, self).__init__(symbols, start, end,
                                                    retry_count, pause,
                                                    timeout, session, freq)
@@ -72,6 +78,9 @@ class RobinhoodHistoricalReader(RobinhoodQuoteReader):
     """
     Read historical values from Robinhood
 
+    DEPRECATED 1/2019 - Robinhood ended support for the endpoints used by this
+    reader
+
     Parameters
     ----------
     symbols : {str, List[str]}
@@ -110,6 +119,7 @@ class RobinhoodHistoricalReader(RobinhoodQuoteReader):
     def __init__(self, symbols, start=None, end=None, retry_count=3, pause=.1,
                  timeout=30, session=None, freq=None, interval='day',
                  span='year'):
+        raise ImmediateDeprecationError(DEP_ERROR_MSG.format("Robinhood"))
         super(RobinhoodHistoricalReader, self).__init__(symbols, start, end,
                                                         retry_count, pause,
                                                         timeout, session, freq)

pandas_datareader/tests/test_robinhood.py

@@ -14,6 +14,7 @@ def symbols(request):
     return request.param
 
 
+@pytest.mark.xfail(reason="Deprecated")
 def test_robinhood_quote(symbols):
     df = RobinhoodQuoteReader(symbols=symbols).read()
     assert isinstance(df, pd.DataFrame)
@@ -22,6 +23,7 @@ def test_robinhood_quote(symbols):
     assert df.shape[1] == len(symbols)
 
 
+@pytest.mark.xfail(reason="Deprecated")
 def test_robinhood_quote_too_many():
     syms = np.random.randint(65, 90, size=(10000, 4)).tolist()
     syms = list(map(lambda r: ''.join(map(chr, r)), syms))
@@ -30,6 +32,7 @@ def test_robinhood_quote_too_many():
         RobinhoodQuoteReader(symbols=syms)
 
 
+@pytest.mark.xfail(reason="Deprecated")
 def test_robinhood_historical_too_many():
     syms = np.random.randint(65, 90, size=(10000, 4)).tolist()
     syms = list(map(lambda r: ''.join(map(chr, r)), syms))
@@ -40,6 +43,7 @@ def test_robinhood_historical_too_many():
         RobinhoodHistoricalReader(symbols=syms[:76])
 
 
+@pytest.mark.xfail(reason="Deprecated")
 def test_robinhood_historical(symbols):
     df = RobinhoodHistoricalReader(symbols=symbols).read()
     assert isinstance(df, pd.DataFrame)