Merge branch 'develop' into bugfix/financials-period-choices

OpenBB-finance · May 22, 2024 · 1c9845e · 1c9845e
2 parents 8ae98cf + 60ff2bd
commit 1c9845e
Show file tree

Hide file tree

Showing 99 changed files with 1,533 additions and 1,444 deletions.
diff --git a/.github/workflows/general-linting.yml b/.github/workflows/general-linting.yml
@@ -65,7 +65,6 @@ jobs:
           # Run linters for openbb_platform
           if [ -n "${{ env.platform_files }}" ]; then
             pylint ${{ env.platform_files }}
-            mypy ${{ env.platform_files }}  --ignore-missing-imports  --scripts-are-modules --check-untyped-defs
             pydocstyle ${{ env.platform_files }}
           else
             echo "No Python files changed in openbb_platform"

diff --git a/build/pypi/openbb_platform/PUBLISH.md b/build/pypi/openbb_platform/PUBLISH.md
@@ -11,15 +11,6 @@
 2. Ensure all the CI workflows pass.
 3. Ensure all unit tests pass: `pytest openbb_platform -m "not integration"`
 4. Ensure all integration tests pass: `pytest openbb_platform -m integration`
-5. Run `python -c "import openbb; openbb.build()"` to build the static assets. Make sure that only required extensions are installed.
-
-    > **Note**: Run `python -c "import openbb"` after building the static to check that no additional static is being built.
-
-6. Finally, check if everything works:
-
-   1. Install the packages locally using `python openbb_platform/dev_install.py` command and test them in a new environment.
-   2. Check if all the `pyproject.toml` files are correct, including the `openbb_platform` one.
-   3. Double check if there is any new extension or provider that needs to be added to [integration tests GitHub Action workflow](/.github/workflows/platform-api-integration-test.yml).
 
 ## Release procedure
 
@@ -35,11 +26,18 @@
     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`
     3. For the `openbb` package - **which requires manual publishing** - do the following
-         - Bump the dependency package versions
-         - Re-build the static assets that are bundled with the package
-         - Run unit tests to validate the existence of deprecated endpoints
-         - Run `poetry publish --build` from `openbb_platform`
-         - Run `poetry lock` from `openbb_platform`
+         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`
 
     > [!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:

diff --git a/cli/poetry.lock b/cli/poetry.lock
diff --git a/cli/pyproject.toml b/cli/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openbb-cli"
-version = "1.0.0"
+version = "1.0.1"
 description = "Investment Research for Everyone, Anywhere."
 authors = ["OpenBB <hello@openbb.co>"]
 packages = [{ include = "openbb_cli" }]
@@ -17,7 +17,7 @@ openbb = 'openbb_cli.cli:main'
 python = "^3.8.1,<3.12"
 
 # OpenBB dependencies
-openbb = { version = "^4.2.0", extras = ["all"] }
+openbb = { version = "^4.2.1", extras = ["all"] }
 
 # CLI dependencies
 prompt-toolkit = "^3.0.16"

diff --git a/openbb_platform/core/poetry.lock b/openbb_platform/core/poetry.lock
diff --git a/openbb_platform/core/pyproject.toml b/openbb_platform/core/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openbb-core"
-version = "1.2.2"
+version = "1.2.3"
 description = "OpenBB package with core functionality."
 authors = ["OpenBB Team <hello@openbb.co>"]
 license = "AGPL-3.0-only"
@@ -22,7 +22,7 @@ requests = "^2.32.1"
 importlib-metadata = "^6.8.0"
 python-dotenv = "^1.0.0"
 aiohttp = "^3.9.5"
-ruff = ">=0.1.6,<=0.4.4"  # Needed here to lint generated code
+ruff = ">=0.1.6,<=0.4.4"      # Needed here to lint generated code
 pyjwt = "^2.8.0"
 
 [build-system]

diff --git a/openbb_platform/extensions/commodity/poetry.lock b/openbb_platform/extensions/commodity/poetry.lock
diff --git a/openbb_platform/extensions/commodity/pyproject.toml b/openbb_platform/extensions/commodity/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openbb-commodity"
-version = "1.1.0"
+version = "1.1.1"
 description = "Commodity extension for OpenBB"
 authors = ["OpenBB Team <hello@openbb.co>"]
 license = "AGPL-3.0-only"
@@ -9,7 +9,7 @@ packages = [{ include = "openbb_commodity" }]
 
 [tool.poetry.dependencies]
 python = "^3.8"
-openbb-core = "^1.2.1"
+openbb-core = "^1.2.3"
 
 [build-system]
 requires = ["poetry-core"]

diff --git a/openbb_platform/extensions/crypto/poetry.lock b/openbb_platform/extensions/crypto/poetry.lock
diff --git a/openbb_platform/extensions/crypto/pyproject.toml b/openbb_platform/extensions/crypto/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openbb-crypto"
-version = "1.2.0"
+version = "1.2.1"
 description = "Crypto extension for OpenBB"
 authors = ["OpenBB Team <hello@openbb.co>"]
 license = "AGPL-3.0-only"
@@ -9,7 +9,7 @@ packages = [{ include = "openbb_crypto" }]
 
 [tool.poetry.dependencies]
 python = "^3.8"
-openbb-core = "^1.2.1"
+openbb-core = "^1.2.3"
 
 [build-system]
 requires = ["poetry-core"]

diff --git a/openbb_platform/extensions/currency/openbb_currency/currency_router.py b/openbb_platform/extensions/currency/openbb_currency/currency_router.py
@@ -28,7 +28,7 @@
         ),
         APIEx(
             description="Search for terms  using 'polygon' as provider.",
-            parameters={"provider": "polygon", "query": "Euro zone"},
+            parameters={"provider": "polygon", "query": "EUR"},
         ),
     ],
 )

diff --git a/openbb_platform/extensions/currency/poetry.lock b/openbb_platform/extensions/currency/poetry.lock
diff --git a/openbb_platform/extensions/currency/pyproject.toml b/openbb_platform/extensions/currency/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openbb-currency"
-version = "1.2.0"
+version = "1.2.1"
 description = "Currency extension for OpenBB"
 authors = ["OpenBB Team <hello@openbb.co>"]
 license = "AGPL-3.0-only"
@@ -9,7 +9,7 @@ packages = [{ include = "openbb_currency" }]
 
 [tool.poetry.dependencies]
 python = "^3.8"
-openbb-core = "^1.2.1"
+openbb-core = "^1.2.3"
 
 [build-system]
 requires = ["poetry-core"]

diff --git a/openbb_platform/extensions/derivatives/openbb_derivatives/options/options_router.py b/openbb_platform/extensions/derivatives/openbb_derivatives/options/options_router.py
@@ -39,7 +39,7 @@ async def chains(
 @router.command(
     model="OptionsUnusual",
     examples=[
-        APIEx(parameters={"provider": "intrinio"}),
+        APIEx(parameters={"symbol": "TSLA", "provider": "intrinio"}),
         APIEx(
             description="Use the 'symbol' parameter to get the most recent activity for a specific symbol.",
             parameters={"symbol": "TSLA", "provider": "intrinio"},

diff --git a/openbb_platform/extensions/derivatives/poetry.lock b/openbb_platform/extensions/derivatives/poetry.lock
diff --git a/openbb_platform/extensions/derivatives/pyproject.toml b/openbb_platform/extensions/derivatives/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openbb-derivatives"
-version = "1.2.0"
+version = "1.2.1"
 description = "Derivatives extension for OpenBB"
 authors = ["OpenBB Team <hello@openbb.co>"]
 license = "AGPL-3.0-only"
@@ -9,7 +9,7 @@ packages = [{ include = "openbb_derivatives" }]
 
 [tool.poetry.dependencies]
 python = "^3.8"
-openbb-core = "^1.2.1"
+openbb-core = "^1.2.3"
 
 [build-system]
 requires = ["poetry-core"]

diff --git a/openbb_platform/extensions/devtools/pyproject.toml b/openbb_platform/extensions/devtools/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openbb-devtools"
-version = "1.2.0"
+version = "1.2.1"
 description = "Tools for OpenBB Platform Developers"
 authors = ["OpenBB Team <hello@openbb.co>"]
 license = "AGPL-3.0-only"

diff --git a/openbb_platform/extensions/econometrics/poetry.lock b/openbb_platform/extensions/econometrics/poetry.lock
diff --git a/openbb_platform/extensions/econometrics/pyproject.toml b/openbb_platform/extensions/econometrics/pyproject.toml
@@ -1,19 +1,19 @@
 [tool.poetry]
 name = "openbb-econometrics"
-version = "1.2.0"
+version = "1.2.1"
 description = "Econometrics Toolkit for OpenBB"
 authors = ["OpenBB Team <hello@openbb.co>"]
 license = "AGPL-3.0-only"
 readme = "README.md"
 packages = [{ include = "openbb_econometrics" }]
 
 [tool.poetry.dependencies]
-python = ">=3.8,<3.12"                 # scipy forces python <4.0 explicitly
+python = ">=3.8,<3.12"  # scipy forces python <4.0 explicitly
 scipy = "^1.10.1"
 statsmodels = "^0.14.0"
 arch = "^5.5.0"
-linearmodels = "<=4.25"                # ^4.26 has setuptools-scm in setup_requires
-openbb-core = "^1.2.1"
+linearmodels = "<=4.25" # ^4.26 has setuptools-scm in setup_requires
+openbb-core = "^1.2.3"
 
 [build-system]
 requires = ["poetry-core"]