Repaired Alpha Vantage naming

addisonlynch · addisonlynch · commit 5d8e568320a0 · 2018-09-10T19:52:46.000-04:00
diff --git a/docs/source/remote_data.rst b/docs/source/remote_data.rst
@@ -30,7 +30,7 @@ Currently the following sources are supported:
     - :ref:`Tiingo<remote_data.tiingo>`
     - :ref:`IEX<remote_data.iex>`
     - :ref:`Robinhood<remote_data.robinhood>`
-    - :ref:`AlphaVantage<remote_data.alphavantage>`
+    - :ref:`Alpha Vantage<remote_data.alphavantage>`
     - :ref:`Enigma<remote_data.enigma>`
     - :ref:`Quandl<remote_data.quandl>`
     - :ref:`St.Louis FED (FRED)<remote_data.fred>`
@@ -112,17 +112,17 @@ year relative to today.
 
 .. _remote_data.alphavantage
 
-AlphaVantage
-============
+Alpha Vantage
+=============
 
-`AlphaVantage <https://www.alphavantage.co/documentation>`__ provides realtime
+`Alpha Vantage <https://www.alphavantage.co/documentation>`__ provides realtime
 equities and forex data. Free registration is required to get an API key.
 
 Historical Time Series Data
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Through the
-`AlphaVantage <https://www.alphavantage.co/documentation>`__ Time Series
+`Alpha Vantage <https://www.alphavantage.co/documentation>`__ Time Series
 endpoints, it is possible to obtain historical equities data for individual
 symbols. The following endpoints are available:
 
@@ -152,7 +152,7 @@ provided.
 Quotes
 ^^^^^^
 
-`AlphaVantage <https://www.alphavantage.co/documentation>`__ Batch Stock Quotes
+`Alpha Vantage <https://www.alphavantage.co/documentation>`__ Batch Stock Quotes
 endpoint allows the retrieval of realtime stock quotes for up to 100 symbols at
 once. These quotes are accessible through the top-level function
 ``get_quote_av``.
@@ -171,7 +171,7 @@ once. These quotes are accessible through the top-level function
 Forex
 ^^^^^
 
-`AlphaVantage <https://www.alphavantage.co/documentation>`__ provides realtime
+`Alpha Vantage <https://www.alphavantage.co/documentation>`__ provides realtime
 currency exchange rates (for physical and digital currencies).
 
 To request the exchange rate of physical or digital currencies, simply format
@@ -199,7 +199,7 @@ Multiple pairs are are allowable:
 Sector Performance
 ^^^^^^^^^^^^^^^^^^
 
-`AlphaVantage <https://www.alphavantage.co/documentation>`__ provides sector
+`Alpha Vantage <https://www.alphavantage.co/documentation>`__ provides sector
 performances through the top-level function ``get_sector_performance_av``.
 
 .. ipython:: python
diff --git a/docs/source/whatsnew/v0.7.0.txt b/docs/source/whatsnew/v0.7.0.txt
@@ -22,23 +22,23 @@ Enhancements
 ~~~~~~~~~~~~
 
 - A new data connector for data provided by
-  `AlphaVantage <https://www.alphavantage.co/documentation>`__ was
+  `Alpha Vantage <https://www.alphavantage.co/documentation>`__ was
   introduced to obtain Foreign Exchange (FX) data.
   (:issue:`389`)
 
 - A new data connector for data provided by
-  `AlphaVantage <https://www.alphavantage.co/documentation>`__ was
+  `Alpha Vantage <https://www.alphavantage.co/documentation>`__ was
   introduced to obtain historical time series data.
   (:issue:`389`)
 
   - A new data connector for data provided by
-  `AlphaVantage <https://www.alphavantage.co/documentation>`__ was
+  `Alpha Vantage <https://www.alphavantage.co/documentation>`__ was
   introduced to obtain sector performance data, accessed through the
   top-level function ``get_sector_performance_av``.
   (:issue:`389`)
 
   - A new data connector for data provided by
-  `AlphaVantage <https://www.alphavantage.co/documentation>`__ was
+  `Alpha Vantage <https://www.alphavantage.co/documentation>`__ was
   introduced to obtain real-time Batch Stock Quotes through the
   top-level function ``get_quote_av``.
   (:issue:`389`)
diff --git a/pandas_datareader/av/__init__.py b/pandas_datareader/av/__init__.py
@@ -10,7 +10,11 @@
 
 class AlphaVantage(_BaseReader):
     """
-    Base class for all AlphaVantage queries
+    Base class for all Alpha Vantage queries
+
+    Notes
+    -----
+    See `Alpha Vantage <https://www.alphavantage.co/>`__
     """
     _format = 'json'
 
@@ -42,12 +46,12 @@ def params(self):
 
     @property
     def function(self):
-        """ AlphaVantage endpoint function"""
+        """ Alpha Vantage endpoint function"""
         raise NotImplementedError
 
     @property
     def data_key(self):
-        """ Key of data returned from AlphaVantage """
+        """ Key of data returned from Alpha Vantage """
         raise NotImplementedError
 
     def _read_lines(self, out):
@@ -61,6 +65,5 @@ def _read_lines(self, out):
             else:
                 raise RemoteDataError()
         df = df[sorted(df.columns)]
-        # df.sort_index(ascending=True, inplace=True)
         df.columns = [id[3:] for id in df.columns]
         return df
diff --git a/pandas_datareader/av/forex.py b/pandas_datareader/av/forex.py
@@ -7,7 +7,7 @@
 
 class AVForexReader(AlphaVantage):
     """
-    Returns DataFrame of the AlphaVantage Foreign Exchange (FX) Exchange Rates
+    Returns DataFrame of the Alpha Vantage Foreign Exchange (FX) Exchange Rates
     data.
 
     .. versionadded:: 0.7.0
@@ -24,7 +24,7 @@ class AVForexReader(AlphaVantage):
     session : Session, default None
         requests.sessions.Session instance to be used
     api_key : str, optional
-        AlphaVantage API key . If not provided the environmental variable
+        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,
diff --git a/pandas_datareader/av/quotes.py b/pandas_datareader/av/quotes.py
@@ -6,7 +6,7 @@
 
 class AVQuotesReader(AlphaVantage):
     """
-    Returns DataFrame of AlphaVantage Realtime Stock quotes for a symbol or
+    Returns DataFrame of Alpha Vantage Realtime Stock quotes for a symbol or
     list of symbols.
 
     Parameters
diff --git a/pandas_datareader/av/sector.py b/pandas_datareader/av/sector.py
@@ -6,7 +6,7 @@
 
 class AVSectorPerformanceReader(AlphaVantage):
     """
-    Returns DataFrame of the AlphaVantage Sector Performances SECTOR data.
+    Returns DataFrame of the Alpha Vantage Sector Performances SECTOR data.
 
     .. versionadded:: 0.7.0
 
@@ -22,7 +22,7 @@ class AVSectorPerformanceReader(AlphaVantage):
     session : Session, default None
         requests.sessions.Session instance to be used
     api_key : str, optional
-        AlphaVantage API key . If not provided the environmental variable
+        Alpha Vantage API key . If not provided the environmental variable
         ALPHAVANTAGE_API_KEY is read. The API key is *required*.
     """
     @property
diff --git a/pandas_datareader/av/time_series.py b/pandas_datareader/av/time_series.py
@@ -5,7 +5,7 @@
 
 class AVTimeSeriesReader(AlphaVantage):
     """
-    Returns DataFrame of the AlphaVantage Stock Time Series endpoints
+    Returns DataFrame of the Alpha Vantage Stock Time Series endpoints
 
     .. versionadded:: 0.7.0
 
@@ -55,7 +55,7 @@ def function(self):
 
     @property
     def output_size(self):
-        """ Used to limit the size of the AlphaVantage query when
+        """ Used to limit the size of the Alpha Vantage query when
         possible.
         """
         delta = datetime.now() - self.start
