From 10fb56651d339d77ab382010cf7f12962fb1ae08 Mon Sep 17 00:00:00 2001 From: Sandro Loch Date: Mon, 4 Dec 2023 15:32:57 -0300 Subject: [PATCH] feat: Add 'data_sources' variable in __init__ --- pysus/online_data/__init__.py | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/pysus/online_data/__init__.py b/pysus/online_data/__init__.py index 5bc9da1..13ef767 100644 --- a/pysus/online_data/__init__.py +++ b/pysus/online_data/__init__.py @@ -135,6 +135,27 @@ def str_to_date(string: str) -> datetime.date: df = df.convert_dtypes() return df +def list_data_sources() -> str: + """ + List all databases supported by PySUS. + + Returns: + - A formatted string listing the supported databases. + """ + + databases_directory = ( + Path(__file__).resolve(strict=True).parent / "ftp" / "databases" + ) + + supported_databases = [ + file + for file in databases_directory.glob("*.py") + if file.name != "__init__.py" + ] + + return f"""Currently, the supported databases are: {', '.join( + file.stem.upper() for file in supported_databases) + }""" class FTP_Inspect: """