Skip to content

DOC: Finish docs for 0.8pre #696

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 18, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ matrix:
- python: 3.7
env: TEST_TYPE="alpha_vantage" PANDAS=0.25 NUMPY=1.17
- python: 3.7
env: TEST_TYPE="not stable" PANDAS=0.25 NUMPY=1.17
env: TEST_TYPE="not stable and not alpha_vantage and not quandl" PANDAS=0.25 NUMPY=1.17
- python: 3.7
env: PANDAS="MASTER" NUMPY=1.17
allow_failures:
Expand All @@ -37,7 +37,7 @@ matrix:
- python: 3.7
env: TEST_TYPE="alpha_vantage" PANDAS=0.25 NUMPY=1.17
- python: 3.7
env: TEST_TYPE="not stable" PANDAS=0.25 NUMPY=1.17
env: TEST_TYPE="not stable and not alpha_vantage and not quandl" PANDAS=0.25 NUMPY=1.17

install:
- source ci/pypi-install.sh;
Expand All @@ -53,19 +53,21 @@ script:
fi
- flake8 --version
- flake8 pandas_datareader

after_script:
- |
if [[ "$DOCBUILD" ]]; then
set -e
cd docs
make html && make html
make html
cd ..
doctr deploy devel --build-tags
if [[ -z "$TRAVIS_TAG" ]]; then
echo "Not a tagged build."
else
doctr deploy stable --build-tags
doctr deploy . --build-tags
fi
set +e
fi

after_script:
- coveralls
- codecov
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,9 +49,9 @@ Many functions from the data module have been included in the top level API.
Documentation
-------------

`Stable documentation <https://pydata.github.io/pandas-datareader/stable/>`__
`Stable documentation <https://pydata.github.io/pandas-datareader/>`__
is available on
`github.io <https://pydata.github.io/pandas-datareader/stable/>`__.
`github.io <https://pydata.github.io/pandas-datareader/>`__.
A second copy of the stable documentation is hosted on
`read the docs <https://pandas-datareader.readthedocs.io/>`_ for more details.

Expand Down
2 changes: 1 addition & 1 deletion ci/pypi-install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -15,5 +15,5 @@ else
fi

if [[ "$DOCBUILD" ]]; then
pip install sphinx ipython matplotlib sphinx_rtd_theme doctr
pip install sphinx ipython matplotlib sphinx_rtd_theme doctr requests_cache
fi
29 changes: 29 additions & 0 deletions docs/contributors.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
"""
Get a list of contributors between now and a start date
"""

import datetime as dt
import os

from github import Github

# or using an access token
g = Github(os.environ.get("GITHUB_API_KEY"))

repo = g.get_repo("pydata/pandas-datareader")

start = dt.datetime(2018, 9, 12, 0, 0, 0)
pulls = repo.get_pulls(state="closed", sort="updated", base="master", direction="desc")

users = set()
for i, p in enumerate(pulls):
print(f"{i}: {p.number}")
if p.merged and p.merged_at >= start:
users.update([p.user.name])
if p.updated_at < start:
break

contrib = sorted((c for c in users if c), key=lambda s: s.split(" ")[-1])

for c in contrib:
print(f"- {c}")
35 changes: 31 additions & 4 deletions docs/source/whatsnew/v0.8.0.txt
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
.. _whatsnew_080:

v0.8.0 (TBD)
---------------------------
------------

Highlights include:

- A new connector for Econdb was introduced. Econdb provides
aggregated economic data from 90+ official statistical agencies
(:issue:`615`)
- Migrated IEX readers to `IEX Cloud <https://iexcloud.io>`__. All
readers now require an API token (``IEX_API_KEY``)
readers now require an API token (``IEX_API_KEY``) (:issue:`638`)
- Removal of Google finance and Morningstar, which were deprecated in 0.7.0.
- Immediate deprecation of Robinhood for quotes and historical data. Robinhood
ended support for these endpoints in 1/2019
Expand All @@ -25,10 +25,12 @@ Highlights include:
Enhancements
~~~~~~~~~~~~

- Added Tiingo IEX Historical reader.
- Added Tiingo IEX Historical reader. (:issue:`619`)
- Added support for Alpha Vantage intraday time series prices (:issue: `631`)
- Up to 15 years of historical prices from IEX with new platform, IEX Cloud
- Added testing on Python 3.7 (:issue:`667`)
- Allow IEX to read less than 1 year of data (:issue:`649`)
- Allow data download from Poland using stooq (:issue:`597`)

.. _whatsnew_080.api_breaking:

Expand All @@ -41,6 +43,7 @@ Backwards incompatible API changes
- Usage of all IEX readers requires an IEX Cloud API token, which can
be passed as a parameter or stored in the environment variable
``IEX_API_TOKEN``
- Deprecated ``access_key`` in favor of ``api_key`` in ``DataReader``. (:issue:`693`)

.. _whatsnew_080.bug_fixes:

Expand All @@ -50,4 +53,28 @@ Bug Fixes
- Fix Yahoo! actions issue where dividends are adjusted twice as a result of a
change to the Yahoo! API. (:issue: `583`)
- Fix AlphaVantage time series data ordering after provider switch to
descending order (maintains ascending order for consistency) (:issue: `662`)
descending order (maintains ascending order for consistency). (:issue: `662`)
- Refactored compatibility library to be independent of pandas version.
- Fixed quarter value handling in JSDMX and OECD. (:issue:`685`)
- Fixed a bug in ``base`` so that the reader does not error when response.encoding
is ``None``. (:issue:`674`)
- Correct EcondbReader's API URL format. (:issue:`670`)
- Fix eurostat URL. (:issue:`669`)
- Adjust Alphavantage time series reader to account for descending ordering. (:issue:`666`)
- Fix bug in downloading index historical constituents. (:issue:`591`)

Contributors
~~~~~~~~~~~~
- Peiji Chen
- EconDB
- Roger Erens
- Nikhilesh Koshti
- Gábor Lipták
- Addison Lynch
- Rahim Nathwani
- Chuk Orakwue
- Raffaele Sandrini
- Felipe S. S. Schneider
- Kevin Sheppard
- Tony Shouse
- David Stephens