4.3.2

OpenBB-finance/OpenBB4.3.2Sep 11, 2024by github-actions[bot]

AI Summary

This release focuses on bug fixes, security updates, and the addition of new public data provider extensions for the CFTC and BLS, alongside enhancements to screener presets and example notebooks.

Key Highlights

  • New public data provider extensions for CFTC and BLS
  • New Finviz screener presets (CANSlim, Fast Growth)
  • Bug fixes for VIX curve and proxy mapping
  • Security updates

Breaking Changes

  • Revenue By Geography and Business Line models now return a flat response instead of a nested dictionary

New Features

  • CFTC Provider Extension
  • BLS Provider Extension
  • New Finviz screener presets
  • Example notebook updates

Full Release Notes

## Thank you and welcome to our new contributors 🔥
@mmistroni and @nnsW3

## Summary 🎉

This release provides bug fixes, example notebook updates, security updates, additional screener presets, as well as new public data provider extensions for the Commodity Futures Trading Commission (CFTC), and The Bureau of Labor Statistics (BLS). 

## What's changed 🚀

### 🚨 OpenBB Platform Breaking Changes

- [Feature] Flatten Revenue By Geography and Business Line @deeleeramone (#6624)
    - In, `obb.equity.fundamental.revenue_per_geography` and `revenue_per_segment`:
      - The breakdown of revenue is now a flat response instead of a nested dictionary, formatted more favorably for Excel, SQL, and pivot tables.

### 🦋 OpenBB Platform Enhancements

- [Feature] Add CFTC Provider and Replace Nasdaq Datalink For COT Reports @deeleeramone (#6643)
  - The `openbb-cftc` extension provides public access to the complete, and current, Commitments of Traders Reports
  - Endpoints:
    - `obb.regulators.cftc.cot`
    - `obb.regulators.cftc.cot_search`
  - Optionally, register for a CFTC app token by creating an account [here](https://evergreen.data.socrata.com/signup) then generating a token [here](https://publicreporting.cftc.gov/profile/edit/developer_settings)

- [Feature] Add BLS Provider Extension With Endpoints For Search and Time Series @deeleeramone (#6630)
  - The `openbb-bls` extension provides public access to the BLS V2 series API with multi-series output and metadata.
  - Requires simple email registration and each key is limited to 500 calls per day, where calls are bucketed into groups of 50 symbols in 20 year historical windows. Register [here](https://data.bls.gov/registrationEngine/)
  - The extension comes with an assets folder containing series IDS and applied metadata maps representing millions of unique time series.
  - Endpoints:
    - `obb.economy.survey.bls_search` - no registration or key is required for this endpoint.
    - `obb.economy.survey.bls_series` - built-in chart when `chart=True` and `openbb-charting` is installed.

- [Feature] Add Top Export Destinations By Country From UN Comtrade International Trade Statistics Database (EconDB) @deeleeramone (#6644)
  - Extends the `openbb-econdb` provider with a new function.
  - New endpoint:
    - `obb.economy.export_destinations`

- [Feature] adding  extra presets @mmistroni (#6623)
  - Adds to the library of `openbb-finviz` screener presets.
  - The new presets will populate in: `~/OpenBBUserData/presets/finviz`
  - Added to `obb.equity.screener(preset=%s, provider="finviz")`:
     - `canslim`
     - `fastgrowths`
     - `newhigh`
   - All presets can be modified by the user in any text editor, with changes applied to the next function call.

### 🐛 OpenBB Platform Bug Fixes

- [BugFix] VIX Curve - fixes `reset_index` erasing the name of the field. @deeleeramone (#6619)
  - Fixes the error when using: `obb.derivatives.futures.curve("VX", provider="cboe")`
  - [BugFix] Fix Pandas FutureWarning In `derivatives.futures.curve` Chart @deeleeramone (#6626)

- [Release] Patch: `openbb-yfinance-1.3.2` @deeleeramone (#6647)
  - [BugFix] Fix Date In Output Of `yfinance.download` For Google Colab @deeleeramone (#6645)
 
- [BugFix] Add `trust_env` to AIOHTTP ClientSession Initialization to Read `.env` for Proxy Mapping @deeleeramone (#6640)
  - Applies the setting to enable environment variable proxy mapping in `aiohttp` async requests.
  - [BugFix] Update `aiohttp` for Dependabot @deeleeramone (#6621)

- [BugFix] Allow lowercase `symbol` for EconDB EconomicIndicators @deeleeramone (#6642)
  - Fixes a UX issue where the symbol - `GDP` - must be entered as uppercase.
  - EconDB symbols are not case-sensitive, converted to upper.

- [BugFix] Fix Tests & Related Bugs @deeleeramone (#6657)
  - Fixes interactive tables (CLI) outputting only white window from `obb.news`, and similar.
  - Fixes unreliable connection/output with `openbb-seeking-alpha` to `obb.equity.estimates.forward_sales` and `forward_eps`.
  - Updates some unit and integration tests.

#### General 

- [BugFix] `obb.news.world` Add Validators To Providers Where Symbol Is Mandatory @deeleeramone (#6625)
- [BugFix] Improve Warning For Invalid Defaults Key In `user_settings.json` @deeleeramone (#6651)
- [BugFix] Replace `Optional[bool]` with `bool` as type in Equity Search @deeleeramone (#6633)
- [BugFix] `__fields__` is deprecated, use `model_fields` instead @deeleeramone (#6629)

## 📚 OpenBB Documentation Changes

- [BugFix] Example Notebook Syntax Updates @deeleeramone (#6639)
  - Outdated syntax in the example notebooks has been updated to reflect recent modifications.

- [BugFix] Docs fix spelling issues @nnsW3 (#6634)


We are proud of our community contributors and staunch supporters of open-source ecosystems.
Help us promote our community by tagging `@openbb_finance` on X with a link to your pull request,
and join our Discord server to chat about your contribution! We want to hear about your experience!

### Links 🦋
[Website](https://openbb.co/), [Twitter](https://twitter.com/openbb_finance), [Linkedin](https://www.linkedin.com/company/openbb-finance), [Instagram](https://www.instagram.com/openbb.finance/), [Reddit](https://www.reddit.com/r/openbb/), [Discord](https://discord.com/invite/xPHTuHCmuV)