v4.2.1

OpenBB-finance/OpenBBv4.2.1May 23, 2024by github-actions[bot]

AI Summary

This release introduces new features like Compare Company Facts and Forward EBITDA, deprecates the ETF holdings performance endpoint, and improves exception handling and security.

Key Highlights

  • Compare Company Facts (SEC) feature
  • Forward EBITDA route added
  • Balance of Payments for FRED added
  • Improved exception handlers

New Features

  • Compare Company Facts (SEC)
  • Forward EBITDA
  • Balance Of Payments for FRED
  • OpenBB Platform DevContainer

Full Release Notes

🌟 What's New in This Release

Explore the enhanced documentation layout and style for a smoother user experience of the OpenBB Platform. Tighten security with upgraded dependencies and refined error handling. Upgrade now for a safer and more streamlined experience! 🚀

## 🦋 OpenBB Platform Enhancements

Release 4.2.1 introduces new features and improvements in the system. The first addition is the "Compare Company Facts" feature, allowing users to compare line items in financial statements across different companies. The new "Forward EBITDA" route has been added to the equity estimates route. This release also sees the removal of the deprecated `etf.holdings_performance` endpoint. The Exception handlers have been improved to ensure more consistent error returns by the API. Lastly, the balance of payments for FRED has been added to expand the macroeconomics data collection. These changes are tested thoroughly for various conditions and parameters to ensure effective performance.

- [Release] 4.2.1 @hjoaquim (#6453)
- [Feature] OpenBB Platform DevContainer @hjoaquim (#6426)
- [Feature] Compare Company Facts (SEC) @deeleeramone (#6444)
- [Feature] Forward EBITDA @deeleeramone (#6433)
- [Feature] Deprecate `etf.holdings_performance` endpoint @hjoaquim (#6441)
- [Feature] Improve Exception handlers @montezdesousa (#6430)
- [Feature] Balance Of Payments For FRED @deeleeramone (#6431)

## 🐛 OpenBB Platform Bug Fixes

This new release implemented software updates, including bug fixes and security improvements.  The list syntax was revamped within routines, making the '-i/--input' argument initially treated as a string and skipping on split comma-separated arguments. Security updates included upgrades to the `idna` and `requests` to patched versions. The dependency on PDF and XLSX export capabilities was removed due to bugs and security vulnerabilities. Other updates improved user interaction, such as handling space-separated arguments better. Certain credentials are only updated on login, preventing unnecessary resetting of user preferences. 

- [BugFix] Move api.dockerfile @montezdesousa (#6454)
- [BugFix] Revamp the usage of list syntax on routines @hjoaquim (#6450)
- Update requests and idna to patched versions @piiq (#6448)
- [BugFix] Add back api.dockerfile @montezdesousa (#6449)
- Remove PDF export capabilities @piiq (#6442)
- Remove xlsx export from CLI's interactive tables @piiq (#6439)
- [BugFix] Bump anyio \& sync pre-commit, openbb-devtools and GitHub workflows @montezdesousa (#6443)
- [BugFix] Add bs4 to SEC pyproject.toml @deeleeramone (#6440)
- [BugFix] Remove space from literals @hjoaquim (#6438)
- [BugFix] Only update credentials on login @montezdesousa (#6437)
- [BugFix] Handle space separated arguments @hjoaquim (#6436)
- [BugFix] FMP Screener - Convert sector param choices to lower\_snake\_case @deeleeramone (#6432)
- [BugFix] FMP Key Metrics @deeleeramone (#6428)
- [BugFix] Do Intrinio News TO-DOs -> Remove workaround because they fixed it. @deeleeramone (#6427)
- [BugFix] Clear Linting Items @deeleeramone (#6423)
- [BugFix] - `dev_install.py` updates @montezdesousa (#6424)

## 📚 OpenBB Documentation Changes

The new release introduces considerable UI and layout changes to the OpenBB Platform documentation and a series of minor style improvements to the OpenBB Platform CLI documentation for enhanced consistency and coherence. All references now uniformly use "OpenBB Platform CLI".  The modifications have been thoroughly tested on the documentation website.

- [Feature] Small CLI docs style improvements @hjoaquim (#6429)
- [Docs] Refactor Docs Pages For Diataxis @deeleeramone  (#6315)

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)