forexflaggr 0.0.3

A minimal package to pull and analyse financial (exchange rate) data.

forexflaggr

A minimal package to pull and analyze financial (forex) data.

Getting started

Installation

Install the latest version of forexflaggr with pip:

pip install forexflaggr

or directly from the source code:

pip install git+https://github.com/ZachWolpe/forexflaggr.git

If the API fails to return data unexpectedly, it may be due to the yahoo finance cache. Empty the cache with:

pip install yfinance --upgrade --no-cache-dir 

Usage

Import the package:

import forexflaggr as fxr

Some key functions:

• fxr.ForexFlaggr().fetch_data() : fetches data from yahoo finance.`
• fxr.ForexFlaggr().plot_data() : plots data`
• fxr.ForexFlaggr.get_price(ff) : returns the price of a given currency pair`.
• fxr.pie_chart_recommendation.plot_pie_recommendation() : plot a recommendation pie chart.
• fxr.LOESS_Model(X, y) : returns a LOESS model.
• fxr.GAM_Model(X, y) : returns a GAM model.

See a complete example usage in ./examples/forexflaggr_runtime.ipynb

Off-the-shelf

For an off-the-shelf USD/ZAR analysis solution in the form of an html doc, run:

import forexflaggr as fxr
fxr.build_html()