Installation

Installing from PyPI

Install with pip for the latest stable version.

pip install finagg

Installing from GitHub

Install from GitHub for the latest unstable version.

git clone https://github.com/theOGognf/finagg.git
pip install ./finagg/

Installing Datasets

Optionally install the recommended datasets (economic data, company financials, stock histories, etc.) from 3rd party APIs into a local SQL database.

finagg install -ss economic -ts indices -z -r

The installation will point you where to get free API keys for each API that requires one and will write those API keys to a local .env file for storage. finagg install is effectively an alias for installing the recommended datasets from each 3rd party API individually. finagg install is equivalent to:

finagg bea install
finagg fred install -a ...
finagg indices install -a ...
finagg sec install -a ...
finagg yfinance install -a ...
finagg fundam install -a ...

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 CLI docs 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 installations by updating Yahoo! Finance data rather than installing from scratch, keeping previously installed data and only installing new data. Instead of calling the normal installation CLI, you can instead do something like the following:

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.