# forexflaggr
A minimal package to pull and analyze financial (forex) data.
# Getting started
## Installation
Install the latest version of forexflaggr with pip:
```bash
pip install forexflaggr
```
or directly from the source code:
```bash
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:
```bash
pip install yfinance --upgrade --no-cache-dir
```
# Usage
Import the package:
```python
import forexflaggr as fxr
```
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:
```python
import forexflaggr as fxr
fxr.build_html()
```
Raw data
{
"_id": null,
"home_page": "https://github.com/ZachWolpe/forexflaggr",
"name": "forexflaggr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Zach Wolpe",
"author_email": "zach.wolpe@mlxgo.com",
"download_url": "https://files.pythonhosted.org/packages/88/51/953561290095b878c1d3ad6782d1b7408497ef54c4138483b2d2724da6b9/forexflaggr-0.0.6.tar.gz",
"platform": null,
"description": "# forexflaggr\n\nA minimal package to pull and analyze financial (forex) data.\n\n# Getting started\n\n\n## Installation\n\nInstall the latest version of forexflaggr with pip:\n\n```bash\npip install forexflaggr\n```\n\nor directly from the source code:\n\n```bash\npip install git+https://github.com/ZachWolpe/forexflaggr.git\n```\n\nIf the API fails to return data unexpectedly, it may be due to the _yahoo finance_ cache. Empty the cache with:\n\n```bash\npip install yfinance --upgrade --no-cache-dir \n```\n\n# Usage\n\nImport the package:\n \n```python\nimport forexflaggr as fxr\n```\n\nkey functions:\n\n- `fxr.ForexFlaggr().fetch_data()` : fetches data from _yahoo finance_.`\n- `fxr.ForexFlaggr().plot_data()` : plots data`\n- `fxr.ForexFlaggr.get_price(ff)` : returns the price of a given currency pair`.\n- `fxr.pie_chart_recommendation.plot_pie_recommendation()` : plot a recommendation pie chart.\n- `fxr.LOESS_Model(X, y)` : returns a LOESS model.\n- `fxr.GAM_Model(X, y)` : returns a GAM model.\n\n\nSee a complete example usage in `./examples/forexflaggr_runtime.ipynb`\n\n# Off-the-shelf\n\nFor an off-the-shelf `USD/ZAR` analysis solution in the form of an `html` doc, run:\n \n```python\nimport forexflaggr as fxr\nfxr.build_html()\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A minimal package to pull and analyse financial (exchange rate) data.",
"version": "0.0.6",
"project_urls": {
"Homepage": "https://github.com/ZachWolpe/forexflaggr"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "87ae0134f443f7409a88e4039f3cb5e4b2048fc0edcdcbfbf4778dba87350e0a",
"md5": "70766fa7caefcb5940f2dcd4f511d667",
"sha256": "d1f337ee33ee775bfcc6b98233576f44e902594c65709d816104f529e8adca0c"
},
"downloads": -1,
"filename": "forexflaggr-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "70766fa7caefcb5940f2dcd4f511d667",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 14070,
"upload_time": "2023-12-05T08:19:55",
"upload_time_iso_8601": "2023-12-05T08:19:55.625293Z",
"url": "https://files.pythonhosted.org/packages/87/ae/0134f443f7409a88e4039f3cb5e4b2048fc0edcdcbfbf4778dba87350e0a/forexflaggr-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8851953561290095b878c1d3ad6782d1b7408497ef54c4138483b2d2724da6b9",
"md5": "d420cda6223a8e15fe49bf5898a5b4cb",
"sha256": "2c348cf4ba46f2c23a734866d839a0b48d537bdb81eb89ac7ca97f88440eeeef"
},
"downloads": -1,
"filename": "forexflaggr-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "d420cda6223a8e15fe49bf5898a5b4cb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11626,
"upload_time": "2023-12-05T08:19:58",
"upload_time_iso_8601": "2023-12-05T08:19:58.831339Z",
"url": "https://files.pythonhosted.org/packages/88/51/953561290095b878c1d3ad6782d1b7408497ef54c4138483b2d2724da6b9/forexflaggr-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-05 08:19:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ZachWolpe",
"github_project": "forexflaggr",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "forexflaggr"
}
JSON
