openbb-derivatives 1.0.0__tar.gz

openbb_derivatives-1.0.0/PKG-INFO

@@ -0,0 +1,32 @@
+Metadata-Version: 2.1
+Name: openbb-derivatives
+Version: 1.0.0
+Summary: Derivatives extension for OpenBB
+Author: OpenBB Team
+Author-email: hello@openbb.co
+Requires-Python: >=3.8,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: openbb-core (>=1.0.0,<2.0.0)
+Description-Content-Type: text/markdown
+
+# OpenBB Derivatives Extension
+
+This extension provides derivatives data for the OpenBB Platform.
+
+## Installation
+
+To install the extension, run the following command in this folder:
+
+```bash
+pip install openbb-derivatives
+```
+
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
+
+Documentation available [here](https://docs.openbb.co/sdk).
+

openbb_derivatives-1.0.0/README.md

@@ -0,0 +1,15 @@
+# OpenBB Derivatives Extension
+
+This extension provides derivatives data for the OpenBB Platform.
+
+## Installation
+
+To install the extension, run the following command in this folder:
+
+```bash
+pip install openbb-derivatives
+```
+
+For development please check [Contribution Guidelines](https://github.com/OpenBB-finance/OpenBBTerminal/blob/develop/openbb_platform/CONTRIBUTING.md).
+
+Documentation available [here](https://docs.openbb.co/sdk).

openbb_derivatives-1.0.0/openbb_derivatives/__init__.py

@@ -0,0 +1 @@
+"""Options."""

openbb_derivatives-1.0.0/openbb_derivatives/derivatives_router.py

@@ -0,0 +1,10 @@
+"""Derivatives Router."""
+
+from openbb_core.app.router import Router
+
+from openbb_derivatives.futures.futures_router import router as futures_router
+from openbb_derivatives.options.options_router import router as options_router
+
+router = Router(prefix="")
+router.include_router(options_router)
+router.include_router(futures_router)

openbb_derivatives-1.0.0/openbb_derivatives/futures/__init__.py

@@ -0,0 +1 @@
+"""Futures."""

openbb_derivatives-1.0.0/openbb_derivatives/futures/futures_router.py

@@ -0,0 +1,37 @@
+"""Futures Router."""
+
+from openbb_core.app.model.command_context import CommandContext
+from openbb_core.app.model.obbject import OBBject
+from openbb_core.app.provider_interface import (
+    ExtraParams,
+    ProviderChoices,
+    StandardParams,
+)
+from openbb_core.app.query import Query
+from openbb_core.app.router import Router
+from pydantic import BaseModel
+
+router = Router(prefix="/futures")
+
+
+# pylint: disable=unused-argument
+@router.command(model="FuturesHistorical")
+async def historical(
+    cc: CommandContext,
+    provider_choices: ProviderChoices,
+    standard_params: StandardParams,
+    extra_params: ExtraParams,
+) -> OBBject[BaseModel]:
+    """Futures Historical Price. Futures historical data."""
+    return await OBBject.from_query(Query(**locals()))
+
+
+@router.command(model="FuturesCurve")
+async def curve(
+    cc: CommandContext,
+    provider_choices: ProviderChoices,
+    standard_params: StandardParams,
+    extra_params: ExtraParams,
+) -> OBBject[BaseModel]:
+    """Futures Historical Price. Futures historical data."""
+    return await OBBject.from_query(Query(**locals()))

openbb_derivatives-1.0.0/openbb_derivatives/options/__init__.py

@@ -0,0 +1 @@
+"""Options."""

openbb_derivatives-1.0.0/openbb_derivatives/options/options_router.py

@@ -0,0 +1,38 @@
+"""Options Router."""
+
+from openbb_core.app.model.command_context import CommandContext
+from openbb_core.app.model.obbject import OBBject
+from openbb_core.app.provider_interface import (
+    ExtraParams,
+    ProviderChoices,
+    StandardParams,
+)
+from openbb_core.app.query import Query
+from openbb_core.app.router import Router
+from pydantic import BaseModel
+
+router = Router(prefix="/options")
+
+# pylint: disable=unused-argument
+
+
+@router.command(model="OptionsChains")
+async def chains(
+    cc: CommandContext,
+    provider_choices: ProviderChoices,
+    standard_params: StandardParams,
+    extra_params: ExtraParams,
+) -> OBBject[BaseModel]:
+    """Get the complete options chain for a ticker."""
+    return await OBBject.from_query(Query(**locals()))
+
+
+@router.command(model="OptionsUnusual")
+async def unusual(
+    cc: CommandContext,
+    provider_choices: ProviderChoices,
+    standard_params: StandardParams,
+    extra_params: ExtraParams,
+) -> OBBject[BaseModel]:
+    """Get the complete options chain for a ticker."""
+    return await OBBject.from_query(Query(**locals()))

openbb_derivatives-1.0.0/pyproject.toml

@@ -0,0 +1,18 @@
+[tool.poetry]
+name = "openbb-derivatives"
+version = "1.0.0"
+description = "Derivatives extension for OpenBB"
+authors = ["OpenBB Team <hello@openbb.co>"]
+readme = "README.md"
+packages = [{ include = "openbb_derivatives" }]
+
+[tool.poetry.dependencies]
+python = "^3.8"
+openbb-core = "^1.0.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.plugins."openbb_core_extension"]
+derivatives = "openbb_derivatives.derivatives_router:router"