diff options
author | Pratyush Shukla <ps4534@nyu.edu> | 2024-03-12 00:29:20 +0530 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-03-11 18:59:20 +0000 |
commit | d458eb96dd5ab86d9bf46e43f6b3edce1c265e3d (patch) | |
tree | 05b672705c2a1ff21f2a889610c6c6c73bc13439 | |
parent | 898222b6bc44e837f339538150e230900aa96d9f (diff) |
[BugFix] Update `README` for Platform (#6189)
* update readme
* prevent oopsies
* beta versions
* print extensions name
* update toml with beta versions
-rw-r--r-- | build/pypi/openbb_platform/publish.py | 5 | ||||
-rw-r--r-- | openbb_platform/README.md | 34 | ||||
-rw-r--r-- | openbb_platform/providers/tmx/pyproject.toml | 2 | ||||
-rw-r--r-- | openbb_platform/providers/tradier/pyproject.toml | 2 | ||||
-rw-r--r-- | openbb_platform/pyproject.toml | 4 |
5 files changed, 24 insertions, 23 deletions
diff --git a/build/pypi/openbb_platform/publish.py b/build/pypi/openbb_platform/publish.py index 4abe874b7be..3d6fb6bf83e 100644 --- a/build/pypi/openbb_platform/publish.py +++ b/build/pypi/openbb_platform/publish.py @@ -51,6 +51,7 @@ def update_extension_dependencies(path: Path): def bump_version(path: Path): """Bump the version of the package""" + print(f"\n> {path.parent.stem}") # noqa: T201 subprocess.run(CMD + VERSION_BUMP_CMD, cwd=path.parent, check=True) # noqa: S603 @@ -77,7 +78,9 @@ def publish(dry_run: bool = False, core: bool = False, extensions: bool = False) # Publish (if not dry run) if not dry_run: subprocess.run( - CMD + PUBLISH_CMD, cwd=path.parent, check=True # noqa: S603 + CMD + PUBLISH_CMD, # noqa: S603 + cwd=path.parent, + check=True, # noqa: S603 ) except Exception as e: print(f"Error publishing {path.parent}:\n{e}") # noqa: T201 diff --git a/openbb_platform/README.md b/openbb_platform/README.md index 23c0a5acb96..40bf3f7fc74 100644 --- a/openbb_platform/README.md +++ b/openbb_platform/README.md @@ -4,9 +4,9 @@ [![LatestRelease](https://badge.fury.io/py/openbb.svg)](https://github.com/OpenBB-finance/OpenBBTerminal) | OpenBB is committed to build the future of investment research by focusing on an open source infrastructure accessible to everyone, everywhere. | -|:--:| -| ![OpenBBLogo](https://user-images.githubusercontent.com/25267873/218899768-1f0964b8-326c-4f35-af6f-ea0946ac970b.png) | -| Check our website at [openbb.co](www.openbb.co) | +| :---------------------------------------------------------------------------------------------------------------------------------------------: | +| ![OpenBBLogo](https://user-images.githubusercontent.com/25267873/218899768-1f0964b8-326c-4f35-af6f-ea0946ac970b.png) | +| Check our website at [openbb.co](www.openbb.co) | ## Overview @@ -22,21 +22,19 @@ pip install openbb This will install the following data providers: -| Extension Name | Description | Installation Command | Minimum Subscription Type Required | -|----------------|-------------|----------------------|------------------------------------| -| openbb-benzinga | [Benzinga](https://www.benzinga.com/apis/en-ca/) data connector | pip install openbb-benzinga | Paid | -| openbb-biztoc | [Biztoc](https://api.biztoc.com/#biztoc-default) News data connector | pip install openbb-biztoc | Free | -| openbb-ecb | [ECB](https://data.ecb.europa.eu/) data connector | pip install openbb-ecb | Free | -| openbb-finra | [FINRA](https://www.finra.org/finra-data) data connector | pip install openbb-finra | Free | -| openbb-finviz | [Finviz](https://finviz.com) data connector | pip install openbb-finra | Free | -| openbb-fmp | [FMP](https://site.financialmodelingprep.com/developer/) data connector | pip install openbb-fmp | Free | -| openbb-fred | [FRED](https://fred.stlouisfed.org/) data connector | pip install openbb-fred | Free | -| openbb-intrinio | [Intrinio](https://intrinio.com/pricing) data connector | pip install openbb-intrinio | Paid | -| openbb-oecd | [OECD](https://data.oecd.org/) data connector | pip install openbb-oecd | Free | -| openbb-polygon | [Polygon](https://polygon.io/) data connector | pip install openbb-polygon | Free | -| openbb-sec | [SEC](https://www.sec.gov/edgar/sec-api-documentation) data connector | pip install openbb-sec | Free | -| openbb-tiingo | [Tiingo](https://www.tiingo.com/about/pricing) data connector | pip install openbb-tiingo | Free | -| openbb-tradingeconomics | [TradingEconomics](https://tradingeconomics.com/api) data connector | pip install openbb-tradingeconomics | Paid | +| Extension Name | Description | Installation Command | Minimum Subscription Type Required | +| ----------------------- | ------------------------------------------------------------------------- | ----------------------------------- | ---------------------------------- | +| openbb-benzinga | [Benzinga](https://www.benzinga.com/apis/en-ca/) data connector | pip install openbb-benzinga | Paid | +| openbb-federal-reserve | [FederalReserve](https://www.federalreserve.gov/data.html) data connector | pip install openbb-federal-reserve | Free | +| openbb-fmp | [FMP](https://site.financialmodelingprep.com/developer/) data connector | pip install openbb-fmp | Free | +| openbb-fred | [FRED](https://fred.stlouisfed.org/) data connector | pip install openbb-fred | Free | +| openbb-intrinio | [Intrinio](https://intrinio.com/pricing) data connector | pip install openbb-intrinio | Paid | +| openbb-oecd | [OECD](https://data.oecd.org/) data connector | pip install openbb-oecd | Free | +| openbb-polygon | [Polygon](https://polygon.io/) data connector | pip install openbb-polygon | Free | +| openbb-sec | [SEC](https://www.sec.gov/edgar/sec-api-documentation) data connector | pip install openbb-sec | Free | +| openbb-tiingo | [Tiingo](https://www.tiingo.com/about/pricing) data connector | pip install openbb-tiingo | Free | +| openbb-tradingeconomics | [TradingEconomics](https://tradingeconomics.com/api) data connector | pip install openbb-tradingeconomics | Paid | +| openbb-yahoo-finance | [Yahoo Finance](https://finance.yahoo.com/) data connector | pip install openbb-yfinance | Free | To install extensions that expand the core functionalities specify the extension name or use `all` to install all. diff --git a/openbb_platform/providers/tmx/pyproject.toml b/openbb_platform/providers/tmx/pyproject.toml index c0e9e95f30a..bb09185b99e 100644 --- a/openbb_platform/providers/tmx/pyproject.toml +++ b/openbb_platform/providers/tmx/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "openbb-tmx" -version = "1.0.0" +version = "1.0.0b" description = "Unofficial TMX data provider extension for the OpenBB Platform - Public Canadian markets data for Python and Fast API." authors = ["OpenBB <hello@openbb.co>"] readme = "README.md" diff --git a/openbb_platform/providers/tradier/pyproject.toml b/openbb_platform/providers/tradier/pyproject.toml index 1e4499a6490..2c052e91430 100644 --- a/openbb_platform/providers/tradier/pyproject.toml +++ b/openbb_platform/providers/tradier/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "openbb-tradier" -version = "1.0.0" +version = "1.0.0b" description = "Tradier Provider Extension for the OpenBB Platform" authors = ["OpenBB <hello@openbb.co>"] readme = "README.md" diff --git a/openbb_platform/pyproject.toml b/openbb_platform/pyproject.toml index 02ca57505bd..af4ec64b10a 100644 --- a/openbb_platform/pyproject.toml +++ b/openbb_platform/pyproject.toml @@ -45,8 +45,8 @@ openbb-government-us = { version = "^1.1.2", optional = true } openbb-nasdaq = { version = "^1.1.3", optional = true } openbb-seeking-alpha = { version = "^1.1.2", optional = true } openbb-stockgrid = { version = "^1.1.2", optional = true } -openbb-tmx = { version = "^1.0.0", optional = true } -openbb-tradier = { version = "^1.0.0", optional = true } +openbb-tmx = { version = "^1.0.0b", optional = true } +openbb-tradier = { version = "^1.0.0b", optional = true } openbb-wsj = { version = "^1.1.2", optional = true } openbb-charting = { version = "^2.0.0", optional = true } |