Skip to content

Commit 0ba13b3

Browse files
committed
DOC: add warning for datareader changes in 0.17.0 (GH10004)
1 parent 3aa8778 commit 0ba13b3

File tree

2 files changed

+28
-7
lines changed

2 files changed

+28
-7
lines changed

doc/source/remote_data.rst

+24-7
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,24 @@
2525
Remote Data Access
2626
******************
2727

28+
.. _remote_data.pandas_datareader:
29+
30+
.. warning::
31+
32+
In pandas 0.17.0, the sub-package ``pandas.io.data`` will be removed in favor of a separately installable `pandas-datareader package <https://github.com/pydata/pandas-datareader>`_. This will allow the data modules to be independently updated to your pandas installation. The API for ``pandas-datareader v0.1.1`` is the same as in ``pandas v0.16.1``. (:issue:`8961`)
33+
34+
You should replace the imports of the following:
35+
36+
.. code-block:: python
37+
38+
from pandas.io import data, wb
39+
40+
With:
41+
42+
.. code-block:: python
43+
44+
from pandas_datareader import data, wb
45+
2846
.. _remote_data.data_reader:
2947

3048
Functions from :mod:`pandas.io.data` and :mod:`pandas.io.ga` extract data from various Internet sources into a DataFrame. Currently the following sources are supported:
@@ -168,7 +186,7 @@ Indicators
168186
~~~~~~~~~~
169187

170188
Either from exploring the World Bank site, or using the search function included,
171-
every world bank indicator is accessible.
189+
every world bank indicator is accessible.
172190

173191
For example, if you wanted to compare the Gross Domestic Products per capita in
174192
constant dollars in North America, you would use the ``search`` function:
@@ -287,7 +305,7 @@ Country Codes
287305
288306
.. versionadded:: 0.15.1
289307
290-
The ``country`` argument accepts a string or list of mixed
308+
The ``country`` argument accepts a string or list of mixed
291309
`two <http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2>`__ or `three <http://en.wikipedia.org/wiki/ISO_3166-1_alpha-3>`__ character
292310
ISO country codes, as well as dynamic `World Bank exceptions <http://data.worldbank.org/node/18>`__ to the ISO standards.
293311
@@ -298,10 +316,10 @@ Problematic Country Codes & Indicators
298316
299317
.. note::
300318
301-
The World Bank's country list and indicators are dynamic. As of 0.15.1,
319+
The World Bank's country list and indicators are dynamic. As of 0.15.1,
302320
:func:`wb.download()` is more flexible. To achieve this, the warning
303321
and exception logic changed.
304-
322+
305323
The world bank converts some country codes in their response, which makes error
306324
checking by pandas difficult. Retired indicators still persist in the search.
307325
@@ -320,12 +338,12 @@ There are at least 4 kinds of country codes:
320338
There are at least 3 kinds of indicators:
321339
322340
1. Current - Returns data.
323-
2. Retired - Appears in search results, yet won't return data.
341+
2. Retired - Appears in search results, yet won't return data.
324342
3. Bad - Will not return data.
325343
326344
Use the ``errors`` argument to control warnings and exceptions. Setting
327345
errors to ignore or warn, won't stop failed responses. (ie, 100% bad
328-
indicators, or a single "bad" (#4 above) country code).
346+
indicators, or a single "bad" (#4 above) country code).
329347
330348
See docstrings for more info.
331349
@@ -387,4 +405,3 @@ Detailed information in the following:
387405
* `pandas & google analytics, by yhat <http://blog.yhathq.com/posts/pandas-google-analytics.html>`__
388406
* `Google Analytics integration in pandas, by Chang She <http://quantabee.wordpress.com/2012/12/17/google-analytics-pandas/>`__
389407
* `Google Analytics Dimensions and Metrics Reference <https://developers.google.com/analytics/devguides/reporting/core/dimsmets>`_
390-

doc/source/whatsnew/v0.16.1.txt

+4
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ Highlights include:
2020

2121
.. _whatsnew_0161.enhancements:
2222

23+
.. warning::
24+
25+
In pandas 0.17.0, the sub-package ``pandas.io.data`` will be removed in favor of a separately installable package. See :ref:`here for details <remote_data.pandas_datareader>` (:issue:`8961`)
26+
2327
Enhancements
2428
~~~~~~~~~~~~
2529

0 commit comments

Comments
 (0)