From 4abad90a5996ffc65fd56931657c28ae65f788b4 Mon Sep 17 00:00:00 2001 From: Ran Aroussi Date: Sat, 20 Nov 2021 20:21:56 +0000 Subject: [PATCH] Delete docs directory --- docs/Ticker.md | 3 - docs/TickerBase.md | 3 - docs/Tickers.md | 3 - docs/_config.yml | 1 - docs/index.md | 18 ---- docs/installation.md | 28 ------ docs/multi.md | 3 - docs/quickstart.md | 201 ------------------------------------------- docs/utils.md | 3 - 9 files changed, 263 deletions(-) delete mode 100644 docs/Ticker.md delete mode 100644 docs/TickerBase.md delete mode 100644 docs/Tickers.md delete mode 100644 docs/_config.yml delete mode 100644 docs/index.md delete mode 100644 docs/installation.md delete mode 100644 docs/multi.md delete mode 100644 docs/quickstart.md delete mode 100644 docs/utils.md diff --git a/docs/Ticker.md b/docs/Ticker.md deleted file mode 100644 index 12f5eaf59..000000000 --- a/docs/Ticker.md +++ /dev/null @@ -1,3 +0,0 @@ -# Ticker - -::: yfinance.ticker.Ticker \ No newline at end of file diff --git a/docs/TickerBase.md b/docs/TickerBase.md deleted file mode 100644 index 1843c1e86..000000000 --- a/docs/TickerBase.md +++ /dev/null @@ -1,3 +0,0 @@ -# TickerBase Reference - -::: yfinance.base.TickerBase \ No newline at end of file diff --git a/docs/Tickers.md b/docs/Tickers.md deleted file mode 100644 index 5d01d62a6..000000000 --- a/docs/Tickers.md +++ /dev/null @@ -1,3 +0,0 @@ -# Tickers Reference - -::: yfinance.tickers.Tickers \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index 2f7efbeab..000000000 --- a/docs/_config.yml +++ /dev/null @@ -1 +0,0 @@ -theme: jekyll-theme-minimal \ No newline at end of file diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index 7eec4fd86..000000000 --- a/docs/index.md +++ /dev/null @@ -1,18 +0,0 @@ -Yahoo! Finance market data downloader -===================================== - -Ever since [Yahoo! finance](https://finance.yahoo.com) decommissioned -their historical data API, many programs that relied on it to stop -working. - -**yfinance** aims to solve this problem by offering a reliable, -threaded, and Pythonic way to download historical market data from -Yahoo! finance. - -NOTE ----- - -The library was originally named `fix-yahoo-finance`, but I've since -renamed it to `yfinance` as I no longer consider it a mere "fix". For -reasons of backward-compatibility, `fix-yahoo-finance` now import and -uses `yfinance`, but you should install and use `yfinance` directly. \ No newline at end of file diff --git a/docs/installation.md b/docs/installation.md deleted file mode 100644 index 9b5ae7a17..000000000 --- a/docs/installation.md +++ /dev/null @@ -1,28 +0,0 @@ -Installation -============ - -Install `yfinance` using `pip`: - -``` {.sourceCode .bash} -$ pip install yfinance --upgrade --no-cache-dir -``` - -Install `yfinance` using `conda`: - -``` {.sourceCode .bash} -$ conda install -c ranaroussi yfinance -``` - -### Requirements - -- [Python](https://www.python.org) \>= 2.7, 3.4+ -- [Pandas](https://github.com/pydata/pandas) (tested to work with - \>=0.23.1) -- [Numpy](http://www.numpy.org) \>= 1.11.1 -- [requests](http://docs.python-requests.org/en/master/) \>= 2.14.2 -- [lxml](https://pypi.org/project/lxml/) \>= 4.5.1 - -### Optional (if you want to use `pandas_datareader`) - -- [pandas\_datareader](https://github.com/pydata/pandas-datareader) - \>= 0.4.0 \ No newline at end of file diff --git a/docs/multi.md b/docs/multi.md deleted file mode 100644 index d48ce7866..000000000 --- a/docs/multi.md +++ /dev/null @@ -1,3 +0,0 @@ -# multi.py Reference - -::: yfinance.multi \ No newline at end of file diff --git a/docs/quickstart.md b/docs/quickstart.md deleted file mode 100644 index 8b4c78ce8..000000000 --- a/docs/quickstart.md +++ /dev/null @@ -1,201 +0,0 @@ -Quick Start -=========== - -The Ticker module ------------------ - -The `Ticker` module, which allows you to access ticker data in a more -Pythonic way: - -Note: yahoo finance datetimes are received as UTC. - -``` {.sourceCode .python} -import yfinance as yf - -msft = yf.Ticker("MSFT") - -# get stock info -msft.info - -# get historical market data -hist = msft.history(period="max") - -# show actions (dividends, splits) -msft.actions - -# show dividends -msft.dividends - -# show splits -msft.splits - -# show financials -msft.financials -msft.quarterly_financials - -# show major holders -msft.major_holders - -# show institutional holders -msft.institutional_holders - -# show balance sheet -msft.balance_sheet -msft.quarterly_balance_sheet - -# show cashflow -msft.cashflow -msft.quarterly_cashflow - -# show earnings -msft.earnings -msft.quarterly_earnings - -# show sustainability -msft.sustainability - -# show analysts recommendations -msft.recommendations - -# show next event (earnings, etc) -msft.calendar - -# show ISIN code - *experimental* -# ISIN = International Securities Identification Number -msft.isin - -# show options expirations -msft.options - -# show news -msft.news - -# get option chain for specific expiration -opt = msft.option_chain('YYYY-MM-DD') -# data available via: opt.calls, opt.puts -``` - -If you want to use a proxy server for downloading data, use: - -``` {.sourceCode .python} -import yfinance as yf - -msft = yf.Ticker("MSFT") - -msft.history(..., proxy="PROXY_SERVER") -msft.get_actions(proxy="PROXY_SERVER") -msft.get_dividends(proxy="PROXY_SERVER") -msft.get_splits(proxy="PROXY_SERVER") -msft.get_balance_sheet(proxy="PROXY_SERVER") -msft.get_cashflow(proxy="PROXY_SERVER") -msft.option_chain(..., proxy="PROXY_SERVER") -... -``` - -To use a custom `requests` session (for example to cache calls to the -API or customize the `User-agent` header), pass a `session=` argument to -the Ticker constructor. - -``` {.sourceCode .python} -import requests_cache -session = requests_cache.CachedSession('yfinance.cache') -session.headers['User-agent'] = 'my-program/1.0' -ticker = yf.Ticker('msft aapl goog', session=session) -# The scraped response will be stored in the cache -ticker.actions -``` - -To initialize multiple `Ticker` objects, use - -``` {.sourceCode .python} -import yfinance as yf - -tickers = yf.Tickers('msft aapl goog') -# ^ returns a named tuple of Ticker objects - -# access each ticker using (example) -tickers.tickers.MSFT.info -tickers.tickers.AAPL.history(period="1mo") -tickers.tickers.GOOG.actions -``` - -Fetching data for multiple tickers ----------------------------------- - -``` {.sourceCode .python} -import yfinance as yf -data = yf.download("SPY AAPL", start="2017-01-01", end="2017-04-30") -``` - -I've also added some options to make life easier :) - -``` {.sourceCode .python} -data = yf.download( # or pdr.get_data_yahoo(... - # tickers list or string as well - tickers = "SPY AAPL MSFT", - - # use "period" instead of start/end - # valid periods: 1d,5d,1mo,3mo,6mo,1y,2y,5y,10y,ytd,max - # (optional, default is '1mo') - period = "ytd", - - # fetch data by interval (including intraday if period < 60 days) - # valid intervals: 1m,2m,5m,15m,30m,60m,90m,1h,1d,5d,1wk,1mo,3mo - # (optional, default is '1d') - interval = "1m", - - # 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 pre/post regular market hours data - # (optional, default is False) - prepost = True, - - # use threads for mass downloading? (True/False/Integer) - # (optional, default is True) - threads = True, - - # proxy URL scheme use use when downloading? - # (optional, default is None) - proxy = None - ) -``` - -Managing Multi-Level Columns ----------------------------- - -The following answer on Stack Overflow is for [How to deal with -multi-level column names downloaded with -yfinance?](https://stackoverflow.com/questions/63107801) - -- `yfinance` returns a `pandas.DataFrame` with multi-level column - names, with a level for the ticker and a level for the stock price - data - - The answer discusses: - - How to correctly read the the multi-level columns after - saving the dataframe to a csv with `pandas.DataFrame.to_csv` - - How to download single or multiple tickers into a single - dataframe with single level column names and a ticker column - -`pandas_datareader` override ----------------------------- - -If your code uses `pandas_datareader` and you want to download data -faster, you can "hijack" `pandas_datareader.data.get_data_yahoo()` -method to use **yfinance** while making sure the returned data is in the -same format as **pandas\_datareader**'s `get_data_yahoo()`. - -``` {.sourceCode .python} -from pandas_datareader import data as pdr - -import yfinance 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") -``` diff --git a/docs/utils.md b/docs/utils.md deleted file mode 100644 index db964a1c1..000000000 --- a/docs/utils.md +++ /dev/null @@ -1,3 +0,0 @@ -# utils.py Reference - -::: yfinance.utils \ No newline at end of file