Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Release] 4.2.2 #6481

Merged
merged 14 commits into from
Jun 5, 2024
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ There are three main ways of contributing to this project. (Hopefully you have s

### Become a Contributor

* More information on our [Contributing Documentation](https://docs.openbb.co/platform/development/contributing).
* More information on our [Contributing Documentation](https://docs.openbb.co/platform/developer_guide/contributing).

### Create a GitHub ticket

Expand Down
6 changes: 3 additions & 3 deletions assets/extensions/provider.json
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@
"packageName": "openbb-federal-reserve",
"optional": false,
"reprName": "Federal Reserve (FED)",
"description": "Access data provided by the Federal Reserve System,\nthe Central Bank of the United States.",
"description": "Access data provided by the Federal Reserve System, the Central Bank of the United States.",
"credentials": [],
"website": "https://www.federalreserve.gov/data.htm"
},
Expand Down Expand Up @@ -155,9 +155,9 @@
"packageName": "openbb-oecd",
"optional": false,
"reprName": "Organization for Economic Co-operation and Development (OECD)",
"description": "OECD.Stat includes data and metadata for OECD countries and selected\nnon-member economies.",
"description": "OECD Data Explorer includes data and metadata for OECD countries and selected\nnon-member economies.",
"credentials": [],
"website": "https://stats.oecd.org"
"website": "https://data-explorer.oecd.org/"
},
{
"packageName": "openbb-polygon",
Expand Down
17 changes: 9 additions & 8 deletions build/pypi/openbb_platform/PUBLISH.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,21 @@
> For a single package release, the following steps are optional since the package can be bumped manually.

1. For the core package run: `python build/pypi/openbb_platform/publish.py --core`
2. For the extension and provider packages run: `python build/pypi/openbb_platform/publish.py --extensions`
2. For the extension packages run: `python build/pypi/openbb_platform/publish.py --extensions`
3. For the `openbb` package - **which requires manual publishing** - do the following
1. Bump the dependency package versions
3.1. Bump the dependency package versions

> [!WARNING]
> Create a new environment before proceeding.
> Make sure that only required extensions are installed

2. Re-build the static assets that are bundled with the package: `python -c "import openbb; openbb.build()"`
- Run `python -c "import openbb"` after building the static to check that no additional static is being built.
- Run any command to smoke test if the static assets are being built correctly.
3. Run unit tests to validate the existence of deprecated endpoints
4. Run `poetry publish --build` from `openbb_platform`
5. Run `poetry lock` from `openbb_platform`
3.2. Run `pip install -e .` from `openbb_platform`
3.3. Re-build the static assets that are bundled with the package: `python -c "import openbb; openbb.build()"`
- Run `python -c "import openbb"` after building the static to check that no additional static is being built.
- Run any command to smoke test if the static assets are being built correctly.
3.4. Run unit tests to validate the existence of deprecated endpoints
3.5. Run `poetry publish --build` from `openbb_platform`
3.6. Run `poetry lock` from `openbb_platform`

> [!TIP]
> Note that, in order for packages to pick up the latest versions of dependencies, it is advised to clear the local cache of the dependencies:
Expand Down
2 changes: 1 addition & 1 deletion build/pypi/openbb_platform/publish.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ def publish(dry_run: bool = False, core: bool = False, extensions: bool = False)
for sub_path in package_paths:
is_extension = sub_path in EXTENSION_PACKAGES

for path in PLATFORM_PATH.rglob(f"{sub_path}/**/pyproject.toml"):
for path in sorted(PLATFORM_PATH.rglob(f"{sub_path}/**/pyproject.toml")):
try:
# Update dependencies
if is_extension and "devtools" not in str(path):
Expand Down
981 changes: 520 additions & 461 deletions cli/poetry.lock

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion cli/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "openbb-cli"
version = "1.0.1"
version = "1.0.2"
description = "Investment Research for Everyone, Anywhere."
authors = ["OpenBB <hello@openbb.co>"]
packages = [{ include = "openbb_cli" }]
Expand All @@ -24,6 +24,7 @@ prompt-toolkit = "^3.0.16"
rich = "^13"
python-dotenv = "^1.0.0"
openpyxl = "^3.1.2"
openbb-core = "^1.2.4"

[build-system]
requires = ["setuptools<65.5.0", "poetry-core>=1.0.0"]
Expand Down
4 changes: 2 additions & 2 deletions openbb_platform/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,15 +42,15 @@ We welcome contributions! If you're looking to contribute, please:
- Ensure your code does not negatively impact performance.
- Test your contributions thoroughly.

Please refer to our [Contributing Guidelines](https://docs.openbb.co/platform/development).
Please refer to our [Contributing Guidelines](https://docs.openbb.co/platform/developer_guide/contributing).

### Collaboration

Engage with the development team and the community. Be open to feedback and collaborative discussions.

### Support

For support, questions, or more information, please visit [OpenBB Platform Documentation](https://docs.openbb.co/platform/development).
For support, questions, or more information, please visit [OpenBB Platform Documentation](https://docs.openbb.co/platform).

### License

Expand Down
Loading
Loading