Skip to content

Commit

Permalink
[Release] 4.3.0 (#6570)
Browse files Browse the repository at this point in the history
* Bump openbb minor version: 4.3.0

* Remove deprecations: /equity/fundamental/overview, /index/market

* Rebuild after deprecations

* Bug fixes

* Fix futures curve example

* Fix equity historical test

* Fix oecd + skip tests

* Fix publishing script

* Update OpenBBTerminal refs to OpenBB, repo renamed

* Released code
  • Loading branch information
montezdesousa authored Jul 9, 2024
1 parent 78445ce commit 61ea77c
Show file tree
Hide file tree
Showing 119 changed files with 1,280 additions and 2,311 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
- [ ] I have performed a self-review of my own code.
- [ ] I have commented my code, particularly in hard-to-understand areas.
- [ ] I have adhered to the GitFlow naming convention and my branch name is in the format of `feature/feature-name` or `hotfix/hotfix-name`.
- [ ] I ensure that I am following the [CONTRIBUTING guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/CONTRIBUTING.md).
- [ ] I ensure that I am following the [CONTRIBUTING guidelines](https://github.com/OpenBB-finance/OpenBB/blob/main/CONTRIBUTING.md).
- [ ] (If applicable) I have updated tests following [these guidelines](/openbb_platform/CONTRIBUTING.md#qa-your-extension).

</details>
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
- [ ] I ensure I have self-reviewed my code.
- [ ] I have commented/documented my code, particularly in hard-to-understand sections.
- [ ] I have adhered to the GitFlow naming convention and my branch name is in the format of `feature/feature-name` or `hotfix/hotfix-name`.
- [ ] Update [our documentation](https://openbb-finance.github.io/OpenBBTerminal/) following [these guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/website). Update any user guides that are affected by the changes.
- [ ] Update our tests following [these guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/tree/main/tests).
- [ ] Make sure you are following our [CONTRIBUTING guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/CONTRIBUTING.md).
- [ ] If a feature was added make sure to add it to the corresponding [integration test script](https://github.com/OpenBB-finance/OpenBBTerminal/tree/develop/openbb_terminal/miscellaneous/integration_tests_scripts).
- [ ] Update [our documentation](https://openbb-finance.github.io/OpenBBTerminal/) following [these guidelines](https://github.com/OpenBB-finance/OpenBB/tree/main/website). Update any user guides that are affected by the changes.
- [ ] Update our tests following [these guidelines](https://github.com/OpenBB-finance/OpenBB/tree/main/tests).
- [ ] Make sure you are following our [CONTRIBUTING guidelines](https://github.com/OpenBB-finance/OpenBB/blob/main/CONTRIBUTING.md).
- [ ] If a feature was added make sure to add it to the corresponding [integration test script](https://github.com/OpenBB-finance/OpenBB/tree/develop/openbb_terminal/miscellaneous/integration_tests_scripts).
2 changes: 1 addition & 1 deletion .github/workflows/gh-branch-name-check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ jobs:
if: steps.check-comment.outputs.commentExists == 'false'
run: |
reason="${{ steps.check-develop-branch.outputs.reason }}${{ steps.check-main-branch.outputs.reason }}"
gh pr comment ${{ github.event.pull_request.number }} --body "$reason Please review our [branch naming guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/CONTRIBUTING.md#branch-naming-conventions)."
gh pr comment ${{ github.event.pull_request.number }} --body "$reason Please review our [branch naming guidelines](https://github.com/OpenBB-finance/OpenBB/blob/develop/CONTRIBUTING.md#branch-naming-conventions)."
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Expand Down
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ If a community member engages in unacceptable behavior, the community organizers

If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible. [email protected].

[Reporting guidelines](https://github.com/OpenBB-finance/OpenBBTerminal)
[Reporting guidelines](https://github.com/OpenBB-finance/OpenBB)

Additionally, community organizers are available to help community members engage with local law enforcement or to otherwise help those experiencing unacceptable behavior feel safe. In the context of in-person events, organizers will also provide escorts as desired by the person experiencing distress.

Expand Down
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
<br />
<img src="https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/images/platform-light.svg?raw=true#gh-light-mode-only" alt="OpenBB Terminal logo" width="600">
<img src="https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/images/platform-dark.svg?raw=true#gh-dark-mode-only" alt="OpenBB Terminal logo" width="600">
<img src="https://github.com/OpenBB-finance/OpenBB/blob/develop/images/platform-light.svg?raw=true#gh-light-mode-only" alt="OpenBB Terminal logo" width="600">
<img src="https://github.com/OpenBB-finance/OpenBB/blob/develop/images/platform-dark.svg?raw=true#gh-dark-mode-only" alt="OpenBB Terminal logo" width="600">
<br />
<br />

[![Twitter](https://img.shields.io/twitter/url/https/twitter.com/openbb_finance.svg?style=social&label=Follow%20%40openbb_finance)](https://twitter.com/openbb_finance)
![Discord Shield](https://discordapp.com/api/guilds/831165782750789672/widget.png?style=shield)
[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/OpenBB-finance/OpenBBTerminal)
[![Open in Dev Containers](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/OpenBB-finance/OpenBB)
<a href="https://codespaces.new/OpenBB-finance/OpenBBTerminal">
<img src="https://github.com/codespaces/badge.svg" height="20" />
</a>
Expand Down Expand Up @@ -50,7 +50,7 @@ If you are looking for the first AI financial terminal for professionals, the Op

The OpenBB Platform can be installed as a [PyPI package](https://pypi.org/project/openbb/) by running `pip install openbb`

or by cloning the repository directly with `git clone https://github.com/OpenBB-finance/OpenBBTerminal.git`.
or by cloning the repository directly with `git clone https://github.com/OpenBB-finance/OpenBB.git`.

Please find more about the installation process in the [OpenBB Documentation](https://docs.openbb.co/platform/installation).

Expand All @@ -60,7 +60,7 @@ The OpenBB Platform CLI is a command-line interface that allows you to access th

It can be installed by running `pip install openbb-cli`

or by cloning the repository directly with `git clone https://github.com/OpenBB-finance/OpenBBTerminal.git`.
or by cloning the repository directly with `git clone https://github.com/OpenBB-finance/OpenBB.git`.

Please find more about the installation process in the [OpenBB Documentation](https://docs.openbb.co/cli/installation).

Expand All @@ -76,11 +76,11 @@ There are three main ways of contributing to this project. (Hopefully you have s

### Create a GitHub ticket

Before creating a ticket make sure the one you are creating doesn't exist already [here](https://github.com/OpenBB-finance/OpenBBTerminal/issues)
Before creating a ticket make sure the one you are creating doesn't exist already [here](https://github.com/OpenBB-finance/OpenBB/issues)

* [Report bug](https://github.com/OpenBB-finance/OpenBBTerminal/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBug%5D)
* [Suggest improvement](https://github.com/OpenBB-finance/OpenBBTerminal/issues/new?assignees=&labels=enhancement&template=enhancement.md&title=%5BIMPROVE%5D)
* [Request a feature](https://github.com/OpenBB-finance/OpenBBTerminal/issues/new?assignees=&labels=new+feature&template=feature_request.md&title=%5BFR%5D)
* [Report bug](https://github.com/OpenBB-finance/OpenBB/issues/new?assignees=&labels=bug&template=bug_report.md&title=%5BBug%5D)
* [Suggest improvement](https://github.com/OpenBB-finance/OpenBB/issues/new?assignees=&labels=enhancement&template=enhancement.md&title=%5BIMPROVE%5D)
* [Request a feature](https://github.com/OpenBB-finance/OpenBB/issues/new?assignees=&labels=new+feature&template=feature_request.md&title=%5BFR%5D)

### Provide feedback

Expand All @@ -89,7 +89,7 @@ We are most active on [our Discord](https://openbb.co/discord), but feel free to
## 3. License

Distributed under the AGPLv3 License. See
[LICENSE](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/LICENSE) for more information.
[LICENSE](https://github.com/OpenBB-finance/OpenBB/blob/main/LICENSE) for more information.

## 4. Disclaimer

Expand Down Expand Up @@ -125,26 +125,26 @@ But for more metrics important to us check [openbb.co/open](https://openbb.co/op

OpenBB wouldn't be OpenBB without you. If we are going to disrupt financial industry, every contribution counts. Thank you for being part of this journey.

<a href="https://github.com/OpenBB-finance/OpenBBTerminal/graphs/contributors">
<a href="https://github.com/OpenBB-finance/OpenBB/graphs/contributors">
<img src="https://contributors-img.web.app/image?repo=OpenBB-finance/OpenBBTerminal" width="800"/>
</a>

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

[contributors-shield]: https://img.shields.io/github/contributors/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge
[contributors-url]: https://github.com/OpenBB-finance/OpenBBTerminal/graphs/contributors
[contributors-url]: https://github.com/OpenBB-finance/OpenBB/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge
[forks-url]: https://github.com/OpenBB-finance/OpenBBTerminal/network/members
[forks-url]: https://github.com/OpenBB-finance/OpenBB/network/members
[stars-shield]: https://img.shields.io/github/stars/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge
[stars-url]: https://github.com/OpenBB-finance/OpenBBTerminal/stargazers
[stars-url]: https://github.com/OpenBB-finance/OpenBB/stargazers
[issues-shield]: https://img.shields.io/github/issues/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge&color=blue
[issues-url]: https://github.com/OpenBB-finance/OpenBBTerminal/issues
[issues-url]: https://github.com/OpenBB-finance/OpenBB/issues
[bugs-open-shield]: https://img.shields.io/github/issues/OpenBB-finance/OpenBBTerminal/bug.svg?style=for-the-badge&color=yellow
[bugs-open-url]: https://github.com/OpenBB-finance/OpenBBTerminal/issues?q=is%3Aissue+label%3Abug+is%3Aopen
[bugs-open-url]: https://github.com/OpenBB-finance/OpenBB/issues?q=is%3Aissue+label%3Abug+is%3Aopen
[bugs-closed-shield]: https://img.shields.io/github/issues-closed/OpenBB-finance/OpenBBTerminal/bug.svg?style=for-the-badge&color=success
[bugs-closed-url]: https://github.com/OpenBB-finance/OpenBBTerminal/issues?q=is%3Aissue+label%3Abug+is%3Aclosed
[bugs-closed-url]: https://github.com/OpenBB-finance/OpenBB/issues?q=is%3Aissue+label%3Abug+is%3Aclosed
[license-shield]: https://img.shields.io/github/license/OpenBB-finance/OpenBBTerminal.svg?style=for-the-badge
[license-url]: https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/LICENSE.txt
[license-url]: https://github.com/OpenBB-finance/OpenBB/blob/main/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/DidierRLopes
2 changes: 1 addition & 1 deletion build/pypi/openbb_platform/PUBLISH.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
2. Bump `openbb` package version in `openbb_platform/pyproject.toml`.

> [!WARNING]
> The version must be incremented before running the tests in 4. and 5., since there are tests that rely of this to check for deprecated endpoints.
> The version must be incremented before running the tests in 4. and 5., since there are tests that rely of this to check for deprecated endpoints. Pay attention to commands that should be deprecated in the version you will publish.
3. Ensure all the CI workflows pass.
4. Ensure all unit tests pass: `pytest openbb_platform -m "not integration"`
Expand Down
1 change: 0 additions & 1 deletion build/pypi/openbb_platform/publish.py
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,6 @@ def publish(
sys.executable,
"-m",
"poetry",
"build",
"publish",
"--build",
],
Expand Down
4 changes: 2 additions & 2 deletions cli/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# OpenBB Platform CLI

[![Downloads](https://static.pepy.tech/badge/openbb)](https://pepy.tech/project/openbb)
[![LatestRelease](https://badge.fury.io/py/openbb.svg)](https://github.com/OpenBB-finance/OpenBBTerminal)
[![LatestRelease](https://badge.fury.io/py/openbb.svg)](https://github.com/OpenBB-finance/OpenBB)

| OpenBB is committed to build the future of investment research by focusing on an open source infrastructure accessible to everyone, everywhere. |
| :---------------------------------------------------------------------------------------------------------------------------------------------: |
Expand Down Expand Up @@ -34,7 +34,7 @@ openbb

Which should result in the following output:

![image](https://github.com/OpenBB-finance/OpenBBTerminal/assets/48914296/f606bb6e-fa00-4fc8-bad2-8269bb4fc38e)
![image](https://github.com/OpenBB-finance/OpenBB/assets/48914296/f606bb6e-fa00-4fc8-bad2-8269bb4fc38e)

## API keys

Expand Down
8 changes: 4 additions & 4 deletions cli/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
[tool.poetry]
name = "openbb-cli"
version = "1.0.4"
version = "1.1.0"
description = "Investment Research for Everyone, Anywhere."
authors = ["OpenBB <[email protected]>"]
packages = [{ include = "openbb_cli" }]
license = "AGPL-3.0-only"
readme = "README.md"
homepage = "https://openbb.co"
repository = "https://github.com/OpenBB-finance/OpenBBTerminal"
documentation = "https://docs.openbb.co/terminal"
repository = "https://github.com/OpenBB-finance/OpenBB"
documentation = "https://docs.openbb.co/cli"

[tool.poetry.scripts]
openbb = 'openbb_cli.cli:main'
Expand All @@ -17,7 +17,7 @@ openbb = 'openbb_cli.cli:main'
python = "^3.9,<3.13"

# OpenBB dependencies
openbb = { version = "^4.2.3", extras = ["all"] }
openbb = { version = "^4.3.0", extras = ["all"] }

# CLI dependencies
prompt-toolkit = "^3.0.16"
Expand Down
16 changes: 8 additions & 8 deletions examples/content.json
Original file line number Diff line number Diff line change
@@ -1,56 +1,56 @@
[
{
"title": "Install in Google Colab",
"url": "https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/examples/googleColab.ipynb",
"url": "https://github.com/OpenBB-finance/OpenBB/blob/develop/examples/googleColab.ipynb",
"img":"https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/develop/examples/googleColab.webp",
"description":
"Install the OpenBB Platform in Google Colab and get started pulling data and creating visualizations."
},
{
"title": "Find Symbols",
"url": "https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/examples/findSymbols.ipynb",
"url": "https://github.com/OpenBB-finance/OpenBB/blob/develop/examples/findSymbols.ipynb",
"img": "https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/develop/examples/findSymbols.webp",
"description":
"An introduction to discovering, finding, screening, and searching symbols using different sources."
},
{
"title": "Load Historical Price Data",
"url": "https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/examples/loadHistoricalPriceData.ipynb",
"url": "https://github.com/OpenBB-finance/OpenBB/blob/develop/examples/loadHistoricalPriceData.ipynb",
"img": "https://my.openbb.co/assets/images/sdk/examples/loadHistoricalPriceData.webp",
"description":
"Loading data with different intervals and sources, ticker symbology, load data from other asset classes, load multiple tickers in one go, draw lines on plotly."
},
{
"title": "Copper To Gold Ratio",
"url": "https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/examples/copperToGoldRatio.ipynb",
"url": "https://github.com/OpenBB-finance/OpenBB/blob/develop/examples/copperToGoldRatio.ipynb",
"img": "https://my.openbb.co/assets/images/sdk/examples/copperToGoldRatio.webp",
"description":
"Calculate copper to gold ratio, load front-month future prices, 10-year constant maturity vs treasury bill, basic dataframe operations, plotting on 2 y-axis."
},
{
"title": "USD Liquidity Index",
"url": "https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/examples/usdLiquidityIndex.ipynb",
"url": "https://github.com/OpenBB-finance/OpenBB/blob/develop/examples/usdLiquidityIndex.ipynb",
"img": "https://my.openbb.co/assets/images/sdk/examples/usdLiquidityIndex.webp",
"description":
"Query the Federal Reserve Economic Database and recreate the USD Liquidity Index, load multiple data series, basic operations on a dataframe, normalization methods, and creating custom chart."
},
{
"title": "Financial Statements",
"url": "https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/examples/financialStatements.ipynb",
"url": "https://github.com/OpenBB-finance/OpenBB/blob/develop/examples/financialStatements.ipynb",
"img": "https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/develop/examples/financialStatements.webp",
"description":
"Get started with financial statements in the OpenBB Platform. This notebook compares the data from different providers and demonstrates how to access items within the three main financial statements - balance, cash, and income."
},
{
"title": "Implied Earnings Move",
"url": "https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/examples/impliedEarningsMove.ipynb",
"url": "https://github.com/OpenBB-finance/OpenBB/blob/develop/examples/impliedEarningsMove.ipynb",
"img": "https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/develop/examples/impliedEarningsMove.webp",
"description":
"Calculate the implied earnings move using options prices. This notebook demonstrates how to get the data from free sources and apply filters to arrive at the expected move, as a percent, in either direction."
},
{
"title": "Streamlit News Headlines",
"url": "https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/examples/streamlit/news.py",
"url": "https://github.com/OpenBB-finance/OpenBB/blob/develop/examples/streamlit/news.py",
"img": "https://raw.githubusercontent.com/OpenBB-finance/OpenBBTerminal/develop/examples/streamlit_news.webp",
"description": "An example Streamlit dashboard for news headlines with data from Biztoc, Benzinga, FMP, Intrinio, and Tiingo."
}
Expand Down
4 changes: 2 additions & 2 deletions openbb_platform/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ This document will take you through two types of contributions:
Before moving forward, please take a look at the high-level view of the OpenBB Platform architecture. We will go over each bit in this document.

<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/OpenBB-finance/OpenBBTerminal/assets/74266147/c9a5a92a-28b6-4257-aefc-deaebe635c6a">
<img alt="OpenBB Platform High-Level Architecture" src="https://github.com/OpenBB-finance/OpenBBTerminal/assets/74266147/c9a5a92a-28b6-4257-aefc-deaebe635c6a">
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/OpenBB-finance/OpenBB/assets/74266147/c9a5a92a-28b6-4257-aefc-deaebe635c6a">
<img alt="OpenBB Platform High-Level Architecture" src="https://github.com/OpenBB-finance/OpenBB/assets/74266147/c9a5a92a-28b6-4257-aefc-deaebe635c6a">
</picture>

#### What is the Standardization Framework?
Expand Down
2 changes: 1 addition & 1 deletion openbb_platform/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# OpenBB Platform

[![Downloads](https://static.pepy.tech/badge/openbb)](https://pepy.tech/project/openbb)
[![LatestRelease](https://badge.fury.io/py/openbb.svg)](https://github.com/OpenBB-finance/OpenBBTerminal)
[![LatestRelease](https://badge.fury.io/py/openbb.svg)](https://github.com/OpenBB-finance/OpenBB)

| OpenBB is committed to build the future of investment research by focusing on an open source infrastructure accessible to everyone, everywhere. |
| :---------------------------------------------------------------------------------------------------------------------------------------------: |
Expand Down
2 changes: 1 addition & 1 deletion openbb_platform/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,4 +54,4 @@ For support, questions, or more information, please visit [OpenBB Platform Docum

### License

This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/OpenBB-finance/OpenBBTerminal/blob/main/LICENSE) file for details.
This project is licensed under the MIT License - see the [LICENSE.md](https://github.com/OpenBB-finance/OpenBB/blob/main/LICENSE) file for details.
Loading

0 comments on commit 61ea77c

Please sign in to comment.