histdatacom 1.0.0__py3-none-any.whl

histdatacom/__init__.py

@@ -0,0 +1,64 @@
+"""Entry point for histdatacom api.
+
+histdatacom(options)
+
+Returns:
+    data: returns a data frame or a list of data frames and metadata
+"""
+
+from __future__ import annotations
+
+import sys
+from typing import TYPE_CHECKING
+
+from histdatacom.fx_enums import Format, Pairs, Timeframe
+from histdatacom.options import Options
+
+if TYPE_CHECKING:
+    from pandas import DataFrame  # type: ignore
+    from polars import DataFrame as PolarsDataFrame
+    from pyarrow import Table
+
+__all__ = [
+    "Options",
+    "Pairs",
+    "Timeframe",
+    "Format",
+]
+
+
+__version__ = "1.0.0"
+__author__ = "David Midlo"
+
+
+class APICaller(sys.modules[__name__].__class__):  # type: ignore # noqa:H601
+    """APICaller. A Masquerade class.
+
+    A class that extends sys.modules[__name__].__class__ (the histdatacom class)
+    extends/overwrites with a __call__ method to allow the module to be callable.
+
+    Returns:
+        data: returns a data frame or a list of data frames and metadata
+    """
+
+    def __call__(  # noqa:BLK001
+        self, options: Options
+    ) -> "list" | "PolarsDataFrame" | "DataFrame" | "Table":
+        """Run histdatacom -h for help.
+
+        Args:
+            options (Options): a histdatacom Options object.
+
+        Returns:
+            "list" | "PolarsDataFrame" | "DataFrame" | "Table":
+                - (list) if called with -A or -U
+                - (PolarsDataFrame) if options.api_return_type = "polars"
+                - (DataFrame) if options.api_return_type = "pandas"
+                - (Table) if options.api_return_type = "arrow"
+        """
+        from . import histdata_com
+
+        return histdata_com.main(options)
+
+
+sys.modules[__name__].__class__ = APICaller

histdatacom/__main__.py

@@ -0,0 +1,21 @@
+# pylint: disable=invalid-name
+"""histdatacom.
+
+Allows histdatacom to be run as a module with
+as >>> python -m histdatacom
+"""
+
+from . import histdata_com  # noqa:WPS130
+
+
+def main() -> None:  # noqa:DAR401
+    """Run histdata_com.main and raise SystemExit on completion.
+
+    Raises:
+        SystemExit: Exit when finished.
+    """
+    raise SystemExit(histdata_com.main())
+
+
+if __name__ == "__main__":
+    main()