Skip to content

Commit

Permalink
add new update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
theOGognf committed Jan 19, 2024
1 parent 19b5c75 commit 66f97f7
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,25 @@ Installation will enable offline usage of aggregated and refined financial
features without internet access or API keys (the recommended way to explore
data uninterrupted). See the :doc:`CLI docs <cli>` for more **finagg** CLI
details.

Updating for Faster Subsequent Installations
--------------------------------------------

Depending on the number of tickers you're aggregating data for, installation
can take up to several hours. The Yahoo! Finance installation process is usually
the main bottleneck (extensive stock histories can take a while to pull from APIs
and can take a while to insert into local databases).

You can speed up subsequent updates by updating Yahoo! Finance data rather than
installing from scratch, keeping previously installed data and only installing
new data. This can result in much faster subsequent installations. Instead of
calling the normal installation CLI, you can instead do something like the
following:

.. code:: console
finagg yfinance update -a
finagg install -s yfinance -ss economic -ts indices -z -r
This will update the Yahoo! Finance tables and then freshly install all the
other tables, resulting in a much faster installation.

0 comments on commit 66f97f7

Please sign in to comment.