Skip to content

Commit b74b1e8

Browse files
authored
Merge pull request #699 from addisonlynch/080-docs
DOC: Update dependency & breaking changes documentation
2 parents ad27478 + e747e47 commit b74b1e8

File tree

3 files changed

+23
-8
lines changed

3 files changed

+23
-8
lines changed

README.rst

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,12 @@ Up to date remote data access for pandas, works for multiple versions of pandas.
2424

2525
.. warning::
2626

27-
As of v0.7.0 Google finance and Morningstar have been been immediately deprecated due to
28-
large changes in their API and no stable replacement.
27+
v0.8.0 is the last version which officially supports Python 2.7. Future versions of ``pandas_datareader`` will end support for Python 2.x.
28+
29+
.. warning::
30+
31+
As of v0.8.0 Robinhood has been immediately deprecated due to
32+
large changes in their API and no stable replacement.
2933

3034

3135
Usage
@@ -69,16 +73,25 @@ Using pandas datareader requires the following packages:
6973
* pandas>=0.19.2
7074
* lxml
7175
* requests>=2.3.0
72-
* wrapt
7376

7477
Building the documentation additionally requires:
7578

7679
* matplotlib
7780
* ipython
81+
* requests_cache
7882
* sphinx
7983
* sphinx_rtd_theme
8084

81-
Testing requires pytest.
85+
Development and testing additionally requires:
86+
87+
* black
88+
* coverage
89+
* codecov
90+
* coveralls
91+
* flake8
92+
* pytest
93+
* pytest-cov
94+
* wrapt
8295

8396
Install latest release version via pip
8497
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

docs/source/remote_data.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,13 @@
1717
Remote Data Access
1818
******************
1919

20+
.. warning::
21+
22+
The ``access_key`` keyword argument of ``DataReader`` has been deprecated in favor of ``api_key``.
2023

2124
.. warning::
2225

23-
Robinhood has been immediately deprecated. Endpoints from this provider
24-
have been retired.
26+
Robinhood has been immediately deprecated. Endpoints from this provider have been retired.
2527

2628
.. _remote_data.data_reader:
2729

@@ -84,7 +86,7 @@ The Investors Exchange (IEX) provides a wide range of data through an
8486
prices are available for up to 15 years. The usage of these readers requires the publishable API key from IEX Cloud Console, which can be stored in the ``IEX_API_KEY`` environment variable.
8587

8688
.. code-block:: ipython
87-
89+
8890
In [1]: import pandas_datareader.data as web
8991
9092
In [2]: from datetime import datetime

docs/source/whatsnew/v0.8.0.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Highlights include:
1010
(:issue:`615`)
1111
- Migrated IEX readers to `IEX Cloud <https://iexcloud.io>`__. All
1212
readers now require an API token (``IEX_API_KEY``) (:issue:`638`)
13-
- Removal of Google finance and Morningstar, which were deprecated in 0.7.0.
13+
- Removal of Google Finance and Morningstar, which were deprecated in 0.7.0
1414
- Immediate deprecation of Robinhood for quotes and historical data. Robinhood
1515
ended support for these endpoints in 1/2019
1616

0 commit comments

Comments
 (0)