fix-yahoo-finance


Namefix-yahoo-finance JSON
Version 0.0.21 PyPI version JSON
download
home_pagehttps://github.com/ranaroussi/fix-yahoo-finance
SummaryFix for Pandas Datareader's get_data_yahoo()
upload_time2018-02-09 21:29:22
maintainer
docs_urlNone
authorRan Aroussi
requires_python
licenseLGPL
keywords pandas
VCS
bugtrack_url
requirements pandas numpy requests multitasking
Travis-CI
coveralls test coverage No coveralls.
            Yahoo! Finance Fix for Pandas Datareader
========================================

.. image:: https://img.shields.io/pypi/pyversions/fix-yahoo-finance.svg?maxAge=60
    :target: https://pypi.python.org/pypi/fix-yahoo-finance
    :alt: Python version

.. image:: https://img.shields.io/travis/ranaroussi/fix-yahoo-finance/master.svg?
    :target: https://travis-ci.org/ranaroussi/fix-yahoo-finance
    :alt: Travis-CI build status

.. image:: https://img.shields.io/pypi/v/fix-yahoo-finance.svg?maxAge=60
    :target: https://pypi.python.org/pypi/fix-yahoo-finance
    :alt: PyPi version

.. image:: https://img.shields.io/pypi/status/fix-yahoo-finance.svg?maxAge=60
    :target: https://pypi.python.org/pypi/fix-yahoo-finance
    :alt: PyPi status

.. image:: https://img.shields.io/github/stars/ranaroussi/fix-yahoo-finance.svg?style=social&label=Star&maxAge=60
    :target: https://github.com/ranaroussi/fix-yahoo-finance
    :alt: Star this repo

.. image:: https://img.shields.io/twitter/follow/aroussi.svg?style=social&label=Follow%20Me&maxAge=60
    :target: https://twitter.com/aroussi
    :alt: Follow me on twitter

\

`Yahoo! finance <https://ichart.finance.yahoo.com>`_ has decommissioned
their historical data API, causing many programs that relied on it to stop working.

**fix-yahoo-finance** offers a **temporary fix** to the problem
by scraping the data from Yahoo! finance using and return a Pandas
DataFrame/Panel in the same format as **pandas_datareader**'s ``get_data_yahoo()``.

By basically "hijacking" ``pandas_datareader.data.get_data_yahoo()`` method,
**fix-yahoo-finance**'s implantation is easy and only requires to import
``fix_yahoo_finance`` into your code.


`Changelog ยป <./CHANGELOG.rst>`__

-----

Quick Start
===========

.. code:: python

    from pandas_datareader import data as pdr

    import fix_yahoo_finance as yf
    yf.pdr_override() # <== that's all it takes :-)

    # download dataframe
    data = pdr.get_data_yahoo("SPY", start="2017-01-01", end="2017-04-30")

    # download Panel
    data = pdr.get_data_yahoo(["SPY", "IWM"], start="2017-01-01", end="2017-04-30")


I've also added some options to make life easier :)

Below is the full list of acceptable parameters:

.. code:: python

    data = pdr.get_data_yahoo(
                # tickers list (single tickers accepts a string as well)
                tickers = ["SPY", "IWM", "..."],

                # start date (YYYY-MM-DD / datetime.datetime object)
                # (optional, defaults is 1950-01-01)
                start = "2017-01-01",

                # end date (YYYY-MM-DD / datetime.datetime object)
                # (optional, defaults is Today)
                end = "2017-04-30",

                # return a multi-index dataframe
                # (optional, default is Panel, which is deprecated)
                as_panel = False,

                # group by ticker (to access via data['SPY'])
                # (optional, default is 'column')
                group_by = 'ticker',

                # adjust all OHLC automatically
                # (optional, default is False)
                auto_adjust = True,

                # download dividend + stock splits data
                # (optional, default is None)
                # options are:
                #   - True (returns history + actions)
                #   - 'only' (actions only)
                actions = True,

                # How may threads to use?
                threads = 10
            )


It can also be used as a stand-alone library (without ``pandas_datareader``) if you want:

.. code:: python

    import fix_yahoo_finance as yf
    data = yf.download("SPY", start="2017-01-01", end="2017-04-30")


Installation
------------

Install ``fix_yahoo_finance`` using ``pip``:

.. code:: bash

    $ pip install fix_yahoo_finance --upgrade --no-cache-dir


Requirements
------------

* `Python <https://www.python.org>`_ >=3.4
* `Pandas <https://github.com/pydata/pandas>`_ (tested to work with >=0.18.1)
* `Numpy <http://www.numpy.org>`_ >= 1.11.1
* `requests <http://docs.python-requests.org/en/master/>`_ >= 2.14.2
* `multitasking <https://github.com/ranaroussi/multitasking>`_ >= 0.0.3


Optional (if you want to use ``pandas_datareader``)
---------------------------------------------------

* `pandas_datareader <https://github.com/pydata/pandas-datareader>`_ >= 0.4.0

Legal Stuff
------------

**fix-yahoo-finance** is distributed under the **GNU Lesser General Public License v3.0**. See the `LICENSE.txt <./LICENSE.txt>`_ file in the release for details.


P.S.
------------

Please drop me an note with any feedback you have.

**Ran Aroussi**

            

Raw data

            {
    "maintainer": "", 
    "docs_url": null, 
    "requires_python": "", 
    "maintainer_email": "", 
    "cheesecake_code_kwalitee_id": null, 
    "keywords": "pandas", 
    "upload_time": "2018-02-09 21:29:22", 
    "requirements": [
        {
            "name": "pandas", 
            "specs": [
                [
                    ">=", 
                    "0.18.1"
                ]
            ]
        }, 
        {
            "name": "numpy", 
            "specs": [
                [
                    ">=", 
                    "1.11.1"
                ]
            ]
        }, 
        {
            "name": "requests", 
            "specs": [
                [
                    ">=", 
                    "2.14.2"
                ]
            ]
        }, 
        {
            "name": "multitasking", 
            "specs": [
                [
                    ">=", 
                    "0.0.3"
                ]
            ]
        }
    ], 
    "author": "Ran Aroussi", 
    "home_page": "https://github.com/ranaroussi/fix-yahoo-finance", 
    "github_user": "ranaroussi", 
    "download_url": "https://pypi.python.org/packages/40/98/1ea043b9f8e5ef7cfa7f90b10b7595245d5a4326e6098de84b03b84ed167/fix-yahoo-finance-0.0.21.tar.gz", 
    "platform": "any", 
    "version": "0.0.21", 
    "cheesecake_documentation_id": null, 
    "description": "Yahoo! Finance Fix for Pandas Datareader\n========================================\n\n.. image:: https://img.shields.io/pypi/pyversions/fix-yahoo-finance.svg?maxAge=60\n    :target: https://pypi.python.org/pypi/fix-yahoo-finance\n    :alt: Python version\n\n.. image:: https://img.shields.io/travis/ranaroussi/fix-yahoo-finance/master.svg?\n    :target: https://travis-ci.org/ranaroussi/fix-yahoo-finance\n    :alt: Travis-CI build status\n\n.. image:: https://img.shields.io/pypi/v/fix-yahoo-finance.svg?maxAge=60\n    :target: https://pypi.python.org/pypi/fix-yahoo-finance\n    :alt: PyPi version\n\n.. image:: https://img.shields.io/pypi/status/fix-yahoo-finance.svg?maxAge=60\n    :target: https://pypi.python.org/pypi/fix-yahoo-finance\n    :alt: PyPi status\n\n.. image:: https://img.shields.io/github/stars/ranaroussi/fix-yahoo-finance.svg?style=social&label=Star&maxAge=60\n    :target: https://github.com/ranaroussi/fix-yahoo-finance\n    :alt: Star this repo\n\n.. image:: https://img.shields.io/twitter/follow/aroussi.svg?style=social&label=Follow%20Me&maxAge=60\n    :target: https://twitter.com/aroussi\n    :alt: Follow me on twitter\n\n\\\n\n`Yahoo! finance <https://ichart.finance.yahoo.com>`_ has decommissioned\ntheir historical data API, causing many programs that relied on it to stop working.\n\n**fix-yahoo-finance** offers a **temporary fix** to the problem\nby scraping the data from Yahoo! finance using and return a Pandas\nDataFrame/Panel in the same format as **pandas_datareader**'s ``get_data_yahoo()``.\n\nBy basically \"hijacking\" ``pandas_datareader.data.get_data_yahoo()`` method,\n**fix-yahoo-finance**'s implantation is easy and only requires to import\n``fix_yahoo_finance`` into your code.\n\n\n`Changelog \u00bb <./CHANGELOG.rst>`__\n\n-----\n\nQuick Start\n===========\n\n.. code:: python\n\n    from pandas_datareader import data as pdr\n\n    import fix_yahoo_finance as yf\n    yf.pdr_override() # <== that's all it takes :-)\n\n    # download dataframe\n    data = pdr.get_data_yahoo(\"SPY\", start=\"2017-01-01\", end=\"2017-04-30\")\n\n    # download Panel\n    data = pdr.get_data_yahoo([\"SPY\", \"IWM\"], start=\"2017-01-01\", end=\"2017-04-30\")\n\n\nI've also added some options to make life easier :)\n\nBelow is the full list of acceptable parameters:\n\n.. code:: python\n\n    data = pdr.get_data_yahoo(\n                # tickers list (single tickers accepts a string as well)\n                tickers = [\"SPY\", \"IWM\", \"...\"],\n\n                # start date (YYYY-MM-DD / datetime.datetime object)\n                # (optional, defaults is 1950-01-01)\n                start = \"2017-01-01\",\n\n                # end date (YYYY-MM-DD / datetime.datetime object)\n                # (optional, defaults is Today)\n                end = \"2017-04-30\",\n\n                # return a multi-index dataframe\n                # (optional, default is Panel, which is deprecated)\n                as_panel = False,\n\n                # group by ticker (to access via data['SPY'])\n                # (optional, default is 'column')\n                group_by = 'ticker',\n\n                # adjust all OHLC automatically\n                # (optional, default is False)\n                auto_adjust = True,\n\n                # download dividend + stock splits data\n                # (optional, default is None)\n                # options are:\n                #   - True (returns history + actions)\n                #   - 'only' (actions only)\n                actions = True,\n\n                # How may threads to use?\n                threads = 10\n            )\n\n\nIt can also be used as a stand-alone library (without ``pandas_datareader``) if you want:\n\n.. code:: python\n\n    import fix_yahoo_finance as yf\n    data = yf.download(\"SPY\", start=\"2017-01-01\", end=\"2017-04-30\")\n\n\nInstallation\n------------\n\nInstall ``fix_yahoo_finance`` using ``pip``:\n\n.. code:: bash\n\n    $ pip install fix_yahoo_finance --upgrade --no-cache-dir\n\n\nRequirements\n------------\n\n* `Python <https://www.python.org>`_ >=3.4\n* `Pandas <https://github.com/pydata/pandas>`_ (tested to work with >=0.18.1)\n* `Numpy <http://www.numpy.org>`_ >= 1.11.1\n* `requests <http://docs.python-requests.org/en/master/>`_ >= 2.14.2\n* `multitasking <https://github.com/ranaroussi/multitasking>`_ >= 0.0.3\n\n\nOptional (if you want to use ``pandas_datareader``)\n---------------------------------------------------\n\n* `pandas_datareader <https://github.com/pydata/pandas-datareader>`_ >= 0.4.0\n\nLegal Stuff\n------------\n\n**fix-yahoo-finance** is distributed under the **GNU Lesser General Public License v3.0**. See the `LICENSE.txt <./LICENSE.txt>`_ file in the release for details.\n\n\nP.S.\n------------\n\nPlease drop me an note with any feedback you have.\n\n**Ran Aroussi**\n", 
    "lcname": "fix-yahoo-finance", 
    "bugtrack_url": null, 
    "github": true, 
    "coveralls": false, 
    "name": "fix-yahoo-finance", 
    "license": "LGPL", 
    "travis_ci": true, 
    "github_project": "fix-yahoo-finance", 
    "summary": "Fix for Pandas Datareader's get_data_yahoo()", 
    "split_keywords": [
        "pandas"
    ], 
    "author_email": "ran@aroussi.com", 
    "urls": [
        {
            "has_sig": false, 
            "upload_time": "2018-02-09T21:29:22", 
            "comment_text": "", 
            "python_version": "source", 
            "url": "https://pypi.python.org/packages/40/98/1ea043b9f8e5ef7cfa7f90b10b7595245d5a4326e6098de84b03b84ed167/fix-yahoo-finance-0.0.21.tar.gz", 
            "md5_digest": "37c6ee98149a26675ce451ab13f129fc", 
            "downloads": 0, 
            "filename": "fix-yahoo-finance-0.0.21.tar.gz", 
            "packagetype": "sdist", 
            "path": "40/98/1ea043b9f8e5ef7cfa7f90b10b7595245d5a4326e6098de84b03b84ed167/fix-yahoo-finance-0.0.21.tar.gz", 
            "size": 10247
        }
    ], 
    "_id": null, 
    "cheesecake_installability_id": null
}