diff options
| author | Diogo Sousa <montezdesousa@gmail.com> | 2024-06-07 16:42:40 +0100 |
|---|---|---|
| committer | Diogo Sousa <montezdesousa@gmail.com> | 2024-06-07 16:42:40 +0100 |
| commit | 4e97c0a0490e2129c109dcd2ffdbc7fc0c09504e (patch) | |
| tree | 163dacf647bc7afd0308005b6c2270bb3a27e3f1 | |
| parent | f283c733a1f160c996184dbbee622816a26d52c3 (diff) | |
feat: v3Credentials -> deprecatedCredentials
11 files changed, 41 insertions, 41 deletions
diff --git a/assets/extensions/provider.json b/assets/extensions/provider.json index 27ff00b11ba..04fa3915039 100644 --- a/assets/extensions/provider.json +++ b/assets/extensions/provider.json @@ -7,9 +7,9 @@ "credentials": [ "alpha_vantage_api_key" ], - "v3Credentials": [ - "API_KEY_ALPHAVANTAGE" - ], + "deprecatedCredentials": { + "API_KEY_ALPHAVANTAGE": "alpha_vantage_api_key" + }, "website": "https://www.alphavantage.co", "instructions": "Go to: https://www.alphavantage.co/support/#api-key\n\n\n\nFill out the form, pass Captcha, and click on, \"GET FREE API KEY\"." }, @@ -31,9 +31,9 @@ "credentials": [ "biztoc_api_key" ], - "v3Credentials": [ - "API_BIZTOC_TOKEN" - ], + "deprecatedCredentials": { + "API_BIZTOC_TOKEN": "biztoc_api_key" + }, "website": "https://api.biztoc.com", "instructions": "The BizToc API is hosted on RapidAPI. To set up, go to: https://rapidapi.com/thma/api/biztoc.\n\n\n\nIn the top right, select 'Sign Up'. After answering some questions, you will be prompted to select one of their plans.\n\n\n\nAfter signing up, navigate back to https://rapidapi.com/thma/api/biztoc. If you are logged in, you will see a header called X-RapidAPI-Key.\n\n" }, @@ -95,9 +95,9 @@ "credentials": [ "fmp_api_key" ], - "v3Credentials": [ - "API_KEY_FINANCIALMODELINGPREP" - ], + "deprecatedCredentials": { + "API_KEY_FINANCIALMODELINGPREP": "fmp_api_key" + }, "website": "https://financialmodelingprep.com", "instructions": "Go to: https://site.financialmodelingprep.com/developer/docs\n\n\n\nClick on, \"Get my API KEY here\", and sign up for a free account.\n\n\n\nWith an account created, sign in and navigate to the Dashboard, which shows the assigned token. by pressing the \"Dashboard\" button which will show the API key.\n\n" }, @@ -109,9 +109,9 @@ "credentials": [ "fred_api_key" ], - "v3Credentials": [ - "API_FRED_KEY" - ], + "deprecatedCredentials": { + "API_FRED_KEY": "fred_api_key" + }, "website": "https://fred.stlouisfed.org", "instructions": "Go to: https://fred.stlouisfed.org\n\n\n\nClick on, \"My Account\", create a new account or sign in with Google:\n\n\n\nAfter completing the sign-up, go to \"My Account\", and select \"API Keys\". Then, click on, \"Request API Key\".\n\n\n\nFill in the box for information about the use-case for FRED, and by clicking, \"Request API key\", at the bottom of the page, the API key will be issued.\n\n" }, @@ -131,9 +131,9 @@ "credentials": [ "intrinio_api_key" ], - "v3Credentials": [ - "API_INTRINIO_KEY" - ], + "deprecatedCredentials": { + "API_INTRINIO_KEY": "intrinio_api_key" + }, "website": "https://intrinio.com", "instructions": "Go to: https://intrinio.com/starter-plan\n\n\n\nAn API key will be issued with a subscription. Find the token value within the account dashboard." }, @@ -145,9 +145,9 @@ "credentials": [ "nasdaq_api_key" ], - "v3Credentials": [ - "API_KEY_QUANDL" - ], + "deprecatedCredentials": { + "API_KEY_QUANDL": "nasdaq_api_key" + }, "website": "https://data.nasdaq.com", "instructions": "Go to: https://www.quandl.com\n\n\n\nClick on, \"Sign Up\", and register a new account.\n\n\n\nFollow the sign-up instructions, and upon completion the API key will be assigned.\n\n" }, @@ -167,9 +167,9 @@ "credentials": [ "polygon_api_key" ], - "v3Credentials": [ - "API_POLYGON_KEY" - ], + "deprecatedCredentials": { + "API_POLYGON_KEY": "polygon_api_key" + }, "website": "https://polygon.io", "instructions": "Go to: https://polygon.io\n\n\n\nClick on, \"Get your Free API Key\".\n\n\n\nAfter signing up, the API Key is found at the bottom of the account dashboard page.\n\n" }, @@ -224,9 +224,9 @@ "tradier_api_key", "tradier_account_type" ], - "v3Credentials": [ - "API_TRADIER_TOKEN" - ], + "deprecatedCredentials": { + "API_TRADIER_TOKEN": "tradier_api_key" + }, "website": "https://tradier.com", "instructions": "Go to: https://documentation.tradier.com\n\n\n\nClick on, \"Open Account\", to start the sign-up process. After the account has been setup, navigate to [Tradier Broker Dash](https://dash.tradier.com/login?redirect=settings.api) and create the application. Request a sandbox access token." }, diff --git a/assets/scripts/generate_extension_data.py b/assets/scripts/generate_extension_data.py index 55bb35d9545..f6ccaefcd73 100644 --- a/assets/scripts/generate_extension_data.py +++ b/assets/scripts/generate_extension_data.py @@ -47,7 +47,7 @@ def to_camel(string: str): return components[0] + "".join(x.title() for x in components[1:]) -def createItem(package_name: str, obj: object, obj_attrs: List[str]) -> Dict[str, Any]: +def create_item(package_name: str, obj: object, obj_attrs: List[str]) -> Dict[str, Any]: """Create dictionary item from object attributes.""" pkg_spec = OPENBB_PLATFORM_TOML.data["tool"]["poetry"]["dependencies"].get( package_name @@ -68,7 +68,7 @@ def generate_provider_extensions() -> None: "repr_name", "description", "credentials", - "v3_credentials", + "deprecated_credentials", "website", "instructions", ] @@ -80,7 +80,7 @@ def generate_provider_extensions() -> None: file, obj = file_obj[0], file_obj[1] module = import_module(file) provider_obj = getattr(module, obj) - data.append(createItem(pkg_name, provider_obj, obj_attrs)) + data.append(create_item(pkg_name, provider_obj, obj_attrs)) write("provider", data) @@ -96,7 +96,7 @@ def generate_router_extensions() -> None: file, obj = file_obj[0], file_obj[1] module = import_module(file) router_obj = getattr(module, obj) - data.append(createItem(pkg_name, router_obj, obj_attrs)) + data.append(create_item(pkg_name, router_obj, obj_attrs)) write("router", data) @@ -112,7 +112,7 @@ def generate_obbject_extensions() -> None: file, obj = file_obj[0], file_obj[1] module = import_module(file) ext_obj = getattr(module, obj) - data.append(createItem(pkg_name, ext_obj, obj_attrs)) + data.append(create_item(pkg_name, ext_obj, obj_attrs)) write("obbject", data) diff --git a/openbb_platform/core/openbb_core/provider/abstract/provider.py b/openbb_platform/core/openbb_core/provider/abstract/provider.py index 756060ba59b..31d3fcf1650 100644 --- a/openbb_platform/core/openbb_core/provider/abstract/provider.py +++ b/openbb_platform/core/openbb_core/provider/abstract/provider.py @@ -17,7 +17,7 @@ class Provider: credentials: Optional[List[str]] = None, fetcher_dict: Optional[Dict[str, Type[Fetcher]]] = None, repr_name: Optional[str] = None, - v3_credentials: Optional[List[str]] = None, + deprecated_credentials: Optional[dict] = None, instructions: Optional[str] = None, ) -> None: """Initialize the provider. @@ -36,8 +36,8 @@ class Provider: Dictionary of fetchers, by default None. repr_name: Optional[str] Full name of the provider, by default None. - v3_credentials: Optional[List[str]] - List of corresponding v3 credentials, by default None. + deprecated_credentials: Optional[dict] + Map of deprecated credentials to its current name, by default None. instructions: Optional[str] Instructions on how to setup the provider. For example, how to get an API key. """ @@ -52,5 +52,5 @@ class Provider: for c in credentials: self.credentials.append(f"{self.name.lower()}_{c}") self.repr_name = repr_name - self.v3_credentials = v3_credentials + self.deprecated_credentials = deprecated_credentials self.instructions = instructions diff --git a/openbb_platform/providers/alpha_vantage/openbb_alpha_vantage/__init__.py b/openbb_platform/providers/alpha_vantage/openbb_alpha_vantage/__init__.py index c88ed9b556c..e6b23918d43 100644 --- a/openbb_platform/providers/alpha_vantage/openbb_alpha_vantage/__init__.py +++ b/openbb_platform/providers/alpha_vantage/openbb_alpha_vantage/__init__.py @@ -21,6 +21,6 @@ cloud-based APIs, Excel, and Google Sheets. """, "EtfHistorical": AVEquityHistoricalFetcher, }, repr_name="Alpha Vantage", - v3_credentials=["API_KEY_ALPHAVANTAGE"], + deprecated_credentials={"API_KEY_ALPHAVANTAGE": "alpha_vantage_api_key"}, instructions='Go to: https://www.alphavantage.co/support/#api-key\n\n\n\nFill out the form, pass Captcha, and click on, "GET FREE API KEY".', # noqa: E501 pylint: disable=line-too-long ) diff --git a/openbb_platform/providers/biztoc/openbb_biztoc/__init__.py b/openbb_platform/providers/biztoc/openbb_biztoc/__init__.py index 8fc02244e20..0b4a94cbc19 100644 --- a/openbb_platform/providers/biztoc/openbb_biztoc/__init__.py +++ b/openbb_platform/providers/biztoc/openbb_biztoc/__init__.py @@ -20,6 +20,6 @@ we've partnered with OpenBB, allowing you to pull in BizToc's news stream in the "WorldNews": BiztocWorldNewsFetcher, }, repr_name="BizToc", - v3_credentials=["API_BIZTOC_TOKEN"], + deprecated_credentials={"API_BIZTOC_TOKEN": "biztoc_api_key"}, instructions="The BizToc API is hosted on RapidAPI. To set up, go to: https://rapidapi.com/thma/api/biztoc.\n\n\n\nIn the top right, select 'Sign Up'. After answering some questions, you will be prompted to select one of their plans.\n\n\n\nAfter signing up, navigate back to https://rapidapi.com/thma/api/biztoc. If you are logged in, you will see a header called X-RapidAPI-Key.\n\n", # noqa: E501 pylint: disable=line-too-long ) diff --git a/openbb_platform/providers/fmp/openbb_fmp/__init__.py b/openbb_platform/providers/fmp/openbb_fmp/__init__.py index dac9f3e8d35..7ae1d68fb91 100644 --- a/openbb_platform/providers/fmp/openbb_fmp/__init__.py +++ b/openbb_platform/providers/fmp/openbb_fmp/__init__.py @@ -138,6 +138,6 @@ stock market information (news, currencies, and stock prices).""", "YieldCurve": FMPYieldCurveFetcher, }, repr_name="Financial Modeling Prep (FMP)", - v3_credentials=["API_KEY_FINANCIALMODELINGPREP"], + deprecated_credentials={"API_KEY_FINANCIALMODELINGPREP": "fmp_api_key"}, instructions='Go to: https://site.financialmodelingprep.com/developer/docs\n\n\n\nClick on, "Get my API KEY here", and sign up for a free account.\n\n\n\nWith an account created, sign in and navigate to the Dashboard, which shows the assigned token. by pressing the "Dashboard" button which will show the API key.\n\n', # noqa: E501 pylint: disable=line-too-long ) diff --git a/openbb_platform/providers/fred/openbb_fred/__init__.py b/openbb_platform/providers/fred/openbb_fred/__init__.py index d68a8d1558e..0a06c3d804d 100644 --- a/openbb_platform/providers/fred/openbb_fred/__init__.py +++ b/openbb_platform/providers/fred/openbb_fred/__init__.py @@ -70,6 +70,6 @@ Research division of the Federal Reserve Bank of St. Louis that has more than "YieldCurve": FREDYieldCurveFetcher, }, repr_name="Federal Reserve Economic Data | St. Louis FED (FRED)", - v3_credentials=["API_FRED_KEY"], + deprecated_credentials={"API_FRED_KEY": "fred_api_key"}, instructions='Go to: https://fred.stlouisfed.org\n\n\n\nClick on, "My Account", create a new account or sign in with Google:\n\n\n\nAfter completing the sign-up, go to "My Account", and select "API Keys". Then, click on, "Request API Key".\n\n\n\nFill in the box for information about the use-case for FRED, and by clicking, "Request API key", at the bottom of the page, the API key will be issued.\n\n', # noqa: E501 pylint: disable=line-too-long ) diff --git a/openbb_platform/providers/intrinio/openbb_intrinio/__init__.py b/openbb_platform/providers/intrinio/openbb_intrinio/__init__.py index 7c0cf34a9ce..b0a033241de 100644 --- a/openbb_platform/providers/intrinio/openbb_intrinio/__init__.py +++ b/openbb_platform/providers/intrinio/openbb_intrinio/__init__.py @@ -106,6 +106,6 @@ historical financial market data to businesses and developers through an API.""" "WorldNews": IntrinioWorldNewsFetcher, }, repr_name="Intrinio", - v3_credentials=["API_INTRINIO_KEY"], + deprecated_credentials={"API_INTRINIO_KEY": "intrinio_api_key"}, instructions="Go to: https://intrinio.com/starter-plan\n\n\n\nAn API key will be issued with a subscription. Find the token value within the account dashboard.", # noqa: E501 pylint: disable=line-too-long ) diff --git a/openbb_platform/providers/nasdaq/openbb_nasdaq/__init__.py b/openbb_platform/providers/nasdaq/openbb_nasdaq/__init__.py index 28babefdc60..190be561181 100644 --- a/openbb_platform/providers/nasdaq/openbb_nasdaq/__init__.py +++ b/openbb_platform/providers/nasdaq/openbb_nasdaq/__init__.py @@ -34,6 +34,6 @@ unmatched technology, insights and markets expertise.""", "TopRetail": NasdaqTopRetailFetcher, }, repr_name="NASDAQ", - v3_credentials=["API_KEY_QUANDL"], + deprecated_credentials={"API_KEY_QUANDL": "nasdaq_api_key"}, instructions='Go to: https://www.quandl.com\n\n\n\nClick on, "Sign Up", and register a new account.\n\n\n\nFollow the sign-up instructions, and upon completion the API key will be assigned.\n\n', # noqa: E501 pylint: disable=line-too-long ) diff --git a/openbb_platform/providers/polygon/openbb_polygon/__init__.py b/openbb_platform/providers/polygon/openbb_polygon/__init__.py index 27b715652c1..c8de4baf566 100644 --- a/openbb_platform/providers/polygon/openbb_polygon/__init__.py +++ b/openbb_platform/providers/polygon/openbb_polygon/__init__.py @@ -40,6 +40,6 @@ company financials, stock market holidays, corporate actions, and more.""", "MarketSnapshots": PolygonMarketSnapshotsFetcher, }, repr_name="Polygon.io", - v3_credentials=["API_POLYGON_KEY"], + deprecated_credentials={"API_POLYGON_KEY": "polygon_api_key"}, instructions='Go to: https://polygon.io\n\n\n\nClick on, "Get your Free API Key".\n\n\n\nAfter signing up, the API Key is found at the bottom of the account dashboard page.\n\n', # noqa: E501 pylint: disable=line-too-long ) diff --git a/openbb_platform/providers/tradier/openbb_tradier/__init__.py b/openbb_platform/providers/tradier/openbb_tradier/__init__.py index 85b5d219ec8..fc94f4711ab 100644 --- a/openbb_platform/providers/tradier/openbb_tradier/__init__.py +++ b/openbb_platform/providers/tradier/openbb_tradier/__init__.py @@ -26,6 +26,6 @@ Tradier Brokerage accounts through our APIs.""", "OptionsChains": TradierOptionsChainsFetcher, }, repr_name="Tradier", - v3_credentials=["API_TRADIER_TOKEN"], + deprecated_credentials={"API_TRADIER_TOKEN": "tradier_api_key"}, instructions='Go to: https://documentation.tradier.com\n\n\n\nClick on, "Open Account", to start the sign-up process. After the account has been setup, navigate to [Tradier Broker Dash](https://dash.tradier.com/login?redirect=settings.api) and create the application. Request a sandbox access token.', # noqa: E501 pylint: disable=line-too-long ) |