Skip to content

Commit

Permalink
deploy: a9e70b4
Browse files Browse the repository at this point in the history
  • Loading branch information
ValueRaider committed Nov 16, 2024
1 parent edaf914 commit 104215c
Show file tree
Hide file tree
Showing 556 changed files with 49,634 additions and 98,133 deletions.
Binary file added docs/.doctrees/advanced/caching.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/.doctrees/development/index.doctree
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
Binary file not shown.
Binary file removed docs/.doctrees/getting_started/installation.doctree
Binary file not shown.
Binary file removed docs/.doctrees/getting_started/legal.doctree
Binary file not shown.
Binary file removed docs/.doctrees/getting_started/quick_start.doctree
Binary file not shown.
Binary file modified docs/.doctrees/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/.doctrees/reference/api/yfinance.EquityQuery.doctree
Binary file not shown.
Binary file modified docs/.doctrees/reference/api/yfinance.Industry.doctree
Binary file not shown.
Binary file modified docs/.doctrees/reference/api/yfinance.Screener.doctree
Binary file not shown.
Binary file modified docs/.doctrees/reference/api/yfinance.Sector.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/.doctrees/reference/api/yfinance.Ticker.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/.doctrees/reference/api/yfinance.Tickers.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/.doctrees/reference/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/.doctrees/reference/yfinance.sector_industry.doctree
Binary file not shown.
Binary file added docs/.doctrees/reference/yfinance.stock.doctree
Binary file not shown.
Binary file modified docs/.doctrees/reference/yfinance.ticker_tickers.doctree
Binary file not shown.
Binary file removed docs/.doctrees/user_guide/index.doctree
Binary file not shown.
Binary file removed docs/.doctrees/user_guide/persistent_cache.doctree
Binary file not shown.
Binary file removed docs/.doctrees/user_guide/smart_scraping.doctree
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
******************************
Smarter Scraping with Caching
******************************
Caching
=======

Smarter Scraping
----------------

Install the `nospam` package to cache API calls and reduce spam to Yahoo:

Expand Down Expand Up @@ -39,3 +40,20 @@ Combine `requests_cache` with rate-limiting to avoid triggering Yahoo's rate-lim
bucket_class=MemoryQueueBucket,
backend=SQLiteCache("yfinance.cache"),
)
Persistent Cache
----------------

To reduce Yahoo, yfinance store some data locally: timezones to localize dates, and cookie. Cache location is:

- Windows = C:/Users/\<USER\>/AppData/Local/py-yfinance
- Linux = /home/\<USER\>/.cache/py-yfinance
- MacOS = /Users/\<USER\>/Library/Caches/py-yfinance

You can direct cache to use a different location with :attr:`set_tz_cache_location <yfinance.set_tz_cache_location>`:

.. code-block:: python
import yfinance as yf
yf.set_tz_cache_location("custom/cache/location")
11 changes: 11 additions & 0 deletions docs/_sources/advanced/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
========
Advanced
========

.. toctree::
:maxdepth: 2

logging
proxy
caching
multi_level_columns
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Logging in yfinance
===================
Logging
=======

`yfinance` uses the `logging` module to handle messages. By default, only errors are logged.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
******************************
Managing Multi-Level Columns
******************************
************************
Multi-Level Column Index
************************

The following answer on Stack Overflow is for `How to deal with
multi-level column names downloaded with yfinance? <https://stackoverflow.com/questions/63107801>`_
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
*********************
Using a Proxy Server
*********************
************
Proxy Server
************

You can download data via a proxy:

Expand Down
3 changes: 2 additions & 1 deletion docs/_sources/development/index.rst.txt
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
===========
Development
===============================
===========

.. toctree::
:maxdepth: 1
Expand Down
9 changes: 0 additions & 9 deletions docs/_sources/getting_started/index.rst.txt

This file was deleted.

17 changes: 0 additions & 17 deletions docs/_sources/getting_started/installation.rst.txt

This file was deleted.

12 changes: 0 additions & 12 deletions docs/_sources/getting_started/legal.rst.txt

This file was deleted.

30 changes: 0 additions & 30 deletions docs/_sources/getting_started/quick_start.rst.txt

This file was deleted.

56 changes: 50 additions & 6 deletions docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
yfinance documentation
==============================================
======================

Download Market Data from Yahoo! Finance's API
------------------------------------------------
----------------------------------------------

.. admonition:: IMPORTANT LEGAL DISCLAIMER

Expand All @@ -19,12 +19,56 @@ Download Market Data from Yahoo! Finance's API
for details on your rights to use the actual data downloaded.
Remember - the Yahoo! finance API is intended for personal use only.

Install
-------

.. code-block:: bash
$ pip install yfinance
Quick start
-----------

Showing a small sample of yfinance API, the full API is much bigger and covered in :doc:`reference/index`.

.. code-block:: python
import yfinance as yf
dat = yf.Ticker("MSFT")
One ticker symbol

.. code-block:: python
dat = yf.Ticker("MSFT")
dat.info
dat.calendar
dat.analyst_price_targets
dat.quarterly_income_stmt
dat.history(period='1mo')
dat.option_chain(dat.options[0]).calls
Multiple ticker symbols

.. code-block:: python
tickers = yf.Tickers('MSFT AAPL GOOG')
tickers.tickers['MSFT'].info
yf.download(['MSFT', 'AAPL', 'GOOG'], period='1mo')
Funds

.. code-block:: python
spy = yf.Ticker('SPY').funds_data
spy.description
spy.top_holdings
.. toctree::
:maxdepth: 3
:hidden:
:maxdepth: 1
:titlesonly:

getting_started/index
user_guide/index
advanced/index
reference/index
development/index

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading

0 comments on commit 104215c

Please sign in to comment.