openbb-fd 1.2.0__py3-none-any.whl

openbb_fd/__init__.py

@@ -0,0 +1,17 @@
+"""Finance Database Provider module."""
+from openbb_core.provider.abstract.provider import Provider
+
+from openbb_fd.models.etf_search import FDEtfSearchFetcher
+from openbb_fd.models.equity_search import FDEquitySearchFetcher
+from openbb_fd.models.crypto_search import FDCryptoSearchFetcher
+
+fd_provider = Provider(
+    name="fd",
+    website="https://github.com/JerBouma/FinanceDatabase",
+    description="A community-managed database of 300.000+ tickers fully categorized.",
+    fetcher_dict={
+        "EtfSearch": FDEtfSearchFetcher,
+        "EquitySearch": FDEquitySearchFetcher,
+        "CryptoSearch": FDCryptoSearchFetcher,
+    },
+)

openbb_fd/models/__init__.py

@@ -0,0 +1 @@
+"""FD data models."""

openbb_fd/models/crypto_search.py

@@ -0,0 +1,92 @@
+"""FD Crypto Search."""
+
+from typing import Any, Dict, List, Optional
+
+from openbb_core.provider.abstract.fetcher import Fetcher
+from openbb_core.provider.standard_models.crypto_search import (
+    CryptoSearchData,
+    CryptoSearchQueryParams,
+)
+from pydantic import Field
+from ..utils.helpers import get_dataset
+
+
+class FDCryptoSearchQueryParams(CryptoSearchQueryParams):
+    """FD Crypto Search Query Params."""
+
+
+class FDCryptoSearchData(CryptoSearchData):
+    """FD Crypto Search Data."""
+
+    __alias_dict__ = {"symbol": "cryptocurrency"}
+
+    exchange_symbol: Optional[str] = Field(
+        description="The exchange symbol of the cryptocurrency.",
+        alias="symbol",
+        default=None,
+    )
+    currency: Optional[str] = Field(
+        description="The currency the crypto is traded in.",
+    )
+    description: Optional[str] = Field(
+        description="A description of the crypto.",
+        alias="summary",
+        default=None,
+    )
+    exchange: Optional[str] = Field(
+        description="The exchange code the crypto trades on.",
+        default=None,
+    )
+    market: Optional[str] = Field(
+        description="The market the crypto trades on.",
+        default=None,
+    )
+
+
+class FDCryptoSearchFetcher(
+    Fetcher[
+        FDCryptoSearchQueryParams,
+        List[FDCryptoSearchData],
+    ]
+):
+    """Transform the query, extract and transform the data from the FD endpoints."""
+
+    @staticmethod
+    def transform_query(params: Dict[str, Any]) -> FDCryptoSearchQueryParams:
+        """Transform the query."""
+        return FDCryptoSearchQueryParams(**params)
+
+    @staticmethod
+    def extract_data(  # pylint: disable=unused-argument
+        query: FDCryptoSearchQueryParams,
+        credentials: Optional[Dict[str, str]],
+        **kwargs: Any,
+    ) -> List[Dict]:
+        """Return the raw data from the FD endpoint."""
+        cryptos = get_dataset("cryptos")
+
+        if query.query:
+            cryptos = cryptos[
+                cryptos["symbol"].str.contains(query.query, case=False)
+                | cryptos["cryptocurrency"].str.contains(query.query, case=False)
+                | cryptos["name"].str.contains(query.query, case=False)
+                | cryptos["currency"].str.contains(query.query, case=False)
+                | cryptos["summary"].str.contains(query.query, case=False)
+                | cryptos["exchange"].str.contains(query.query, case=False)
+                | cryptos["market"].str.contains(query.query, case=False)
+            ]
+        for col in cryptos:
+            if cryptos[col].dtype in ("int", "float"):
+                cryptos[col] = cryptos[col].fillna(0)
+            elif cryptos[col].dtype == "string":
+                cryptos[col] = cryptos[col].fillna("")
+        return cryptos.to_dict("records")
+
+    @staticmethod
+    def transform_data(  # pylint: disable=unused-argument
+        query: FDCryptoSearchQueryParams,
+        data: List[Dict],
+        **kwargs: Any,
+    ) -> List[FDCryptoSearchData]:
+        """Return the transformed data."""
+        return [FDCryptoSearchData.model_validate(d) for d in data]

openbb_fd/models/equity_search.py

@@ -0,0 +1,169 @@
+"""FD Equity Search."""
+
+from typing import Any, Dict, List, Optional
+
+from openbb_core.provider.abstract.fetcher import Fetcher
+from openbb_core.provider.standard_models.equity_search import (
+    EquitySearchData,
+    EquitySearchQueryParams,
+)
+from pydantic import Field
+from ..utils.helpers import get_dataset
+
+
+class FDEquitySearchQueryParams(EquitySearchQueryParams):
+    """FD Equity Search Query Params."""
+
+
+class FDEquitySearchData(EquitySearchData):
+    """FD Equity Search Data."""
+
+    description: Optional[str] = Field(
+        description="A description of the company.",
+        alias="summary",
+        default=None,
+    )
+
+    currency: Optional[str] = Field(
+        description="The currency the equity is traded in.",
+    )
+
+    sector: Optional[str] = Field(
+        description="The sector the company belongs to.",
+        default=None,
+    )
+
+    industry_group: Optional[str] = Field(
+        description="The industry group the company belongs to.",
+        default=None,
+    )
+
+    industry: Optional[str] = Field(
+        description="The industry the company belongs to.",
+        default=None,
+    )
+
+    exchange: Optional[str] = Field(
+        description="The exchange code the equity trades on.",
+        default=None,
+    )
+
+    market: Optional[str] = Field(
+        description="The market the equity trades on.",
+        default=None,
+    )
+
+    country: Optional[str] = Field(
+        description="The country of the company's address.",
+        default=None,
+    )
+
+    state: Optional[str] = Field(
+        description="The state of the company's address.",
+        default=None,
+    )
+
+    city: Optional[str] = Field(
+        description="The city of the company's address.",
+        default=None,
+    )
+
+    zipcode: Optional[str] = Field(
+        description="The zipcode of the company's address.",
+        default=None,
+    )
+
+    website: Optional[str] = Field(
+        description="The website of the company.",
+        default=None,
+    )
+
+    market_cap: Optional[str] = Field(
+        description="The market cap of the company.",
+        default=None,
+    )
+
+    isin: Optional[str] = Field(
+        description="The ISIN of the equity.",
+        default=None,
+    )
+
+    cusip: Optional[str] = Field(
+        description="The CUSIP of the equity.",
+        default=None,
+    )
+
+    figi: Optional[str] = Field(
+        description="The FIGI of the equity.",
+        default=None,
+    )
+
+    composite_figi: Optional[str] = Field(
+        description="The composite FIGI of the equity.",
+        default=None,
+    )
+
+    shareclass_figi: Optional[str] = Field(
+        description="The shareclass FIGI of the equity.",
+        default=None,
+    )
+
+
+class FDEquitySearchFetcher(
+    Fetcher[
+        FDEquitySearchQueryParams,
+        List[FDEquitySearchData],
+    ]
+):
+    """Transform the query, extract and transform the data from the FD endpoints."""
+
+    @staticmethod
+    def transform_query(params: Dict[str, Any]) -> FDEquitySearchQueryParams:
+        """Transform the query."""
+        return FDEquitySearchQueryParams(**params)
+
+    @staticmethod
+    def extract_data(  # pylint: disable=unused-argument
+        query: FDEquitySearchQueryParams,
+        credentials: Optional[Dict[str, str]],
+        **kwargs: Any,
+    ) -> List[Dict]:
+        """Return the raw data from the FD endpoint."""
+        equities = get_dataset("equities")
+
+        if query.query:
+            equities = equities[
+                equities["symbol"].str.contains(query.query, case=False)
+                | equities["name"].str.contains(query.query, case=False)
+                | equities["summary"].str.contains(query.query, case=False)
+                | equities["currency"].str.contains(query.query, case=False)
+                | equities["sector"].str.contains(query.query, case=False)
+                | equities["industry_group"].str.contains(query.query, case=False)
+                | equities["industry"].str.contains(query.query, case=False)
+                | equities["exchange"].str.contains(query.query, case=False)
+                | equities["market"].str.contains(query.query, case=False)
+                | equities["country"].str.contains(query.query, case=False)
+                | equities["state"].str.contains(query.query, case=False)
+                | equities["city"].str.contains(query.query, case=False)
+                | equities["zipcode"].str.contains(query.query, case=False)
+                | equities["website"].str.contains(query.query, case=False)
+                | equities["market_cap"].str.contains(query.query, case=False)
+                | equities["isin"].str.contains(query.query, case=False)
+                | equities["cusip"].str.contains(query.query, case=False)
+                | equities["figi"].str.contains(query.query, case=False)
+                | equities["composite_figi"].str.contains(query.query, case=False)
+                | equities["shareclass_figi"].str.contains(query.query, case=False)
+            ]
+        for col in equities:
+            if equities[col].dtype in ("int", "float"):
+                equities[col] = equities[col].fillna(0)
+            elif equities[col].dtype == "string":
+                equities[col] = equities[col].fillna("")
+        return equities.to_dict("records")
+
+    @staticmethod
+    def transform_data(  # pylint: disable=unused-argument
+        query: FDEquitySearchQueryParams, data: List[Dict], **kwargs: Any
+    ) -> List[FDEquitySearchData]:
+        """Return the transformed data."""
+        return [FDEquitySearchData.model_validate(d) for d in data]

openbb_fd/models/etf_search.py

@@ -0,0 +1,98 @@
+"""FD ETF Search."""
+
+from typing import Any, Dict, List, Optional
+
+# import pandas as pd
+from openbb_core.provider.abstract.fetcher import Fetcher
+from openbb_core.provider.standard_models.etf_search import (
+    EtfSearchData,
+    EtfSearchQueryParams,
+)
+from pydantic import Field
+from ..utils.helpers import get_dataset
+
+
+class FDEtfSearchQueryParams(EtfSearchQueryParams):
+    """FD ETF Search Query Params."""
+
+
+class FDEtfSearchData(EtfSearchData):
+    """FD ETF Search Data."""
+
+    currency: Optional[str] = Field(
+        description="The currency the ETF is traded in.",
+    )
+    description: Optional[str] = Field(
+        description="A description of the ETF.",
+        alias="summary",
+        default=None,
+    )
+    category_group: Optional[str] = Field(
+        description="The category group the ETF belongs to.",
+        default=None,
+    )
+    category: Optional[str] = Field(
+        description="The category the ETF belongs to.",
+        default=None,
+    )
+    family: Optional[str] = Field(
+        description="The family the ETF belongs to.",
+        default=None,
+    )
+    exchange: Optional[str] = Field(
+        description="The exchange code the ETF trades on.",
+        default=None,
+    )
+    market: Optional[str] = Field(
+        description="The market the ETF trades on.",
+        default=None,
+    )
+
+
+class FDEtfSearchFetcher(
+    Fetcher[
+        FDEtfSearchQueryParams,
+        List[FDEtfSearchData],
+    ]
+):
+    """Transform the query, extract and transform the data from the FD endpoints."""
+
+    @staticmethod
+    def transform_query(params: Dict[str, Any]) -> FDEtfSearchQueryParams:
+        """Transform the query."""
+        return FDEtfSearchQueryParams(**params)
+
+    @staticmethod
+    def extract_data(  # pylint: disable=unused-argument
+        query: FDEtfSearchQueryParams,
+        credentials: Optional[Dict[str, str]],
+        **kwargs: Any,
+    ) -> List[Dict]:
+        """Return the raw data from the FD endpoint."""
+        etfs = get_dataset("etfs")
+
+        if query.query:
+            etfs = etfs[
+                etfs["symbol"].str.contains(query.query, case=False)
+                | etfs["name"].str.contains(query.query, case=False)
+                | etfs["currency"].str.contains(query.query, case=False)
+                | etfs["summary"].str.contains(query.query, case=False)
+                | etfs["category_group"].str.contains(query.query, case=False)
+                | etfs["category"].str.contains(query.query, case=False)
+                | etfs["family"].str.contains(query.query, case=False)
+                | etfs["exchange"].str.contains(query.query, case=False)
+                | etfs["market"].str.contains(query.query, case=False)
+            ]
+        for col in etfs:
+            if etfs[col].dtype in ("int", "float"):
+                etfs[col] = etfs[col].fillna(0)
+            elif etfs[col].dtype == "string":
+                etfs[col] = etfs[col].fillna("")
+        return etfs.to_dict("records")
+
+    @staticmethod
+    def transform_data(  # pylint: disable=unused-argument
+        query: FDEtfSearchQueryParams, data: List[Dict], **kwargs: Any
+    ) -> List[FDEtfSearchData]:
+        """Return the transformed data."""
+        return [FDEtfSearchData.model_validate(d) for d in data]

openbb_fd/utils/__init__.py

@@ -0,0 +1 @@
+"""FD package utils."""

openbb_fd/utils/helpers.py

@@ -0,0 +1,63 @@
+"""Helper for downloading data to a local location."""
+import os
+from typing import Literal
+
+import pandas as pd
+import requests
+
+GITHUB_ROOT_URL = "https://raw.githubusercontent.com/"
+GITHUB_DATA_FOLDER = "JerBouma/FinanceDatabase/main/compression/"
+LOCAL_FOLDER = os.path.join(os.path.dirname(__file__), "..", "data")
+
+_dataset = Literal[
+    "cryptos", "currencies", "equities", "etfs", "funds", "indices", "moneymarkets"
+]
+
+
+def _get_github_etag(dataset: _dataset) -> str:
+    """Get ETag for a dataset on GitHub."""
+    url = GITHUB_ROOT_URL + GITHUB_DATA_FOLDER + f"{dataset}.bz2"
+    response = requests.head(url, timeout=1)
+    return response.headers.get("ETag", "")
+
+
+def _get_saved_etag(dataset: _dataset) -> str:
+    """Get saved ETag for a dataset."""
+    etag_file = os.path.join(LOCAL_FOLDER, f"{dataset}.etag")
+    if os.path.exists(etag_file):
+        with open(etag_file, "r", encoding="utf-8") as f:
+            return f.read().strip()
+    return ""
+
+
+def _save_etag(dataset: _dataset, etag: str) -> None:
+    """Save ETag for a dataset."""
+    etag_file = os.path.join(LOCAL_FOLDER, f"{dataset}.etag")
+    with open(etag_file, "w", encoding="utf-8") as f:
+        f.write(etag)
+
+
+def _download_and_save(dataset: _dataset) -> None:
+    """Download and save dataset from GitHub."""
+    if not os.path.exists(LOCAL_FOLDER):
+        os.makedirs(LOCAL_FOLDER)
+    print(f"Downloading {dataset}...")
+    url = GITHUB_ROOT_URL + GITHUB_DATA_FOLDER + f"{dataset}.bz2"
+    data = pd.read_csv(url, compression="bz2", header=0)
+    data.to_csv(os.path.join(LOCAL_FOLDER, f"{dataset}.csv"), index=False)
+    etag = _get_github_etag(dataset)
+    if etag:
+        _save_etag(dataset, etag)
+
+
+def get_dataset(dataset: _dataset) -> pd.DataFrame:
+    """Get dataset from the data directory."""
+    local_path = os.path.join(LOCAL_FOLDER, f"{dataset}.csv")
+    if not os.path.exists(local_path):
+        _download_and_save(dataset)
+    else:
+        saved_etag = _get_saved_etag(dataset)
+        current_etag = _get_github_etag(dataset)
+        if saved_etag != current_etag:
+            _download_and_save(dataset)
+    return pd.read_csv(local_path, header=0).convert_dtypes()

openbb_fd-1.2.0.dist-info/LICENSE

@@ -0,0 +1,73 @@
+# Licenses
+
+## openbb-fd License
+
+MIT License
+
+Copyright (c) 2023 Theodore Aptekarev.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+## OpenBB License
+
+MIT License
+
+Copyright (c) 2021-2023 OpenBB Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+## Finance Database License
+
+MIT License
+
+Copyright (c) 2023 Jeroen Bouma
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

openbb_fd-1.2.0.dist-info/METADATA

@@ -0,0 +1,69 @@
+Metadata-Version: 2.3
+Name: openbb-fd
+Version: 1.2.0
+Summary: Integration of Jeroen Bouma's Finance Database with OpenBB
+Author: piiq
+Author-email: piiq@tinag.ru
+Requires-Python: >=3.9,<3.13
+Classifier: Programming Language :: Python :: 3
+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.3.8,<2.0.0)
+Description-Content-Type: text/markdown
+
+# Finance Database provider for OpenBB
+
+Finance Database by Jeroen Bouma offers an extensive collection of over 300,000 symbols across various financial instruments, including Equities, ETFs, Funds, Indices, Currencies, Cryptocurrencies, and Money Markets. It's designed to provide a comprehensive overview of sectors, industries, and types of investments.
+
+## Introduction
+
+This extension integrates the Finance Database datasets into OpenBB. It enhances the capabilities of OpenBB’s equity, crypto, and ETF search functionalities. This integration adds capabilities to search through a broad spectrum of financial instruments.
+
+## Installation
+
+To install this extension, you can use pip:
+
+```bash
+pip install openbb-fd
+```
+
+Alternatively, for the latest version directly from the repository:
+
+```bash
+pip install git+https://github.com/piiq/openbb-fd.git
+```
+
+## Usage
+
+Here are some command examples to demonstrate the usage of this integration:
+
+To search for equities in a defense industry:
+
+```bash
+>>> sample = obb.equity.search(query="Defense", provider="fd")
+>>> print(f"Total companies in the sample: {len(sample.to_df()['name'].unique())}")
+Total companies in the sample: 880
+```
+
+To find ETFs matching certain criteria:
+
+```python
+>>> sample = obb.etf.search(query="Wheat", provider="fd")
+>>> print(f"Total etfs in the sample: {len(sample.to_df()['name'].unique())}")
+Total etfs in the sample: 10
+```
+
+For cryptocurrency analysis:
+
+```python
+>>> sample = obb.crypto.search(query="node", provider="fd")
+>>> print(f"Total cryptos in the sample: {len(sample.to_df()['name'].unique())}")
+Total cryptos in the sample: 10
+```
+
+## License
+
+This project is licensed under the MIT License.
+

openbb_fd-1.2.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+openbb_fd/__init__.py,sha256=UZkdJpOtq6C0OHvUbcbPp-F3qEvkAdIX7TxIIFFJc7Q,639
+openbb_fd/models/__init__.py,sha256=eeI9L3CJS9ighFYcZwn5wcX2WYah77xbBcHrMo8hk9M,22
+openbb_fd/models/crypto_search.py,sha256=gig52WgOtEiJpBbdVgm7K87zLwnZ0_M0jcVsYc4QjqQ,3095
+openbb_fd/models/equity_search.py,sha256=mRUHZ69zkYskai66xJ-Yxgr8W30hVnYSNBXV_NhHPqs,5588
+openbb_fd/models/etf_search.py,sha256=3mlsOYz9b_dykZrjsqF3m4h-6qHLaj6f4z0oN1JXGbg,3276
+openbb_fd/utils/__init__.py,sha256=U5dzEolv0Pix792cNrJH-RY-u98iAS6C3jXI-zTDEzQ,24
+openbb_fd/utils/helpers.py,sha256=Z_Mk9vG3QkIncmZjuWAONDZxL29rYO5hIFT4AWXIb1c,2180
+openbb_fd-1.2.0.dist-info/LICENSE,sha256=WmY4VnOuf1Yr47mXS9SeFntnroKsiLTvFTDwggpnGrQ,3302
+openbb_fd-1.2.0.dist-info/METADATA,sha256=ChCgPlfRdDc5cfdX3qoQnE7rDbDcR1kuPV91J5DzPyU,2224
+openbb_fd-1.2.0.dist-info/WHEEL,sha256=IYZQI976HJqqOpQU6PHkJ8fb3tMNBFjg-Cn-pwAbaFM,88
+openbb_fd-1.2.0.dist-info/entry_points.txt,sha256=9xz6LlDHkfFKTLkgadrYLYlQ66jNHNIRRZXYyDciX54,54
+openbb_fd-1.2.0.dist-info/RECORD,,

openbb_fd-1.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.0.1
+Root-Is-Purelib: true
+Tag: py3-none-any

openbb_fd-1.2.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[openbb_provider_extension]
+fd=openbb_fd:fd_provider
+