detquantlib 3.7.1__tar.gz → 3.8.0__tar.gz

{detquantlib-3.7.1 → detquantlib-3.8.0}/PKG-INFO

@@ -1,7 +1,8 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: detquantlib
-Version: 3.7.1
+Version: 3.8.0
 Summary: An internal library containing functions and classes that can be used across Quant models.
+License-File: LICENSE.txt
 Author: DET
 Requires-Python: >=3.10,<4.0
 Classifier: Programming Language :: Python :: 3
@@ -9,10 +10,11 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Requires-Dist: numpy (>=2.2.6,<3.0.0)
-Requires-Dist: pandas (>=2.3.0,<3.0.0)
-Requires-Dist: paramiko (>=3.5.1,<4.0.0)
-Requires-Dist: plotly (>=6.1.2,<7.0.0)
+Requires-Dist: pandas (>=2.3.3,<3.0.0)
+Requires-Dist: paramiko (>=4.0.0,<5.0.0)
+Requires-Dist: plotly (>=6.3.1,<7.0.0)
 Requires-Dist: pyodbc (>=5.2.0,<6.0.0)
 Requires-Dist: python-dotenv (>=1.1.0,<2.0.0)
 Requires-Dist: scipy (>=1.15.2,<2.0.0)

{detquantlib-3.7.1 → detquantlib-3.8.0}/detquantlib/figures/plotly_figures.py

@@ -5,10 +5,8 @@ from pathlib import Path
 import plotly.graph_objects as go
 import plotly.io as pio
 
-
-def get_default_plotly_folder_dir():
-    # Default path to output folder containing plotly figures.
-    return Path.cwd().joinpath("Outputs", "PlotlyFigures")
+# Internal modules
+from detquantlib.outputs.outputs_interface import PathDefinitions
 
 
 def set_standard_layout(fig: go.Figure) -> go.Figure:
@@ -34,7 +32,7 @@ def set_standard_layout(fig: go.Figure) -> go.Figure:
 def save_plotly_fig_to_json(
     fig: go.Figure,
     filename: str,
-    folder_dir: Path = get_default_plotly_folder_dir(),
+    folder_dir: Path = PathDefinitions.get_outputs_plotly_folder_dir(),
     standard_layout: bool = True,
 ):
     """
@@ -65,7 +63,7 @@ def save_plotly_fig_to_json(
 def save_plotly_fig_to_html(
     fig: go.Figure,
     filename: str,
-    folder_dir: Path = get_default_plotly_folder_dir(),
+    folder_dir: Path = PathDefinitions.get_outputs_plotly_folder_dir(),
     standard_layout: bool = True,
 ):
     """
@@ -91,7 +89,9 @@ def save_plotly_fig_to_html(
     fig.write_html(file_dir)
 
 
-def show_plotly_fig_json(filename: str, folder_dir: Path = get_default_plotly_folder_dir()):
+def show_plotly_fig_json(
+    filename: str, folder_dir: Path = PathDefinitions.get_outputs_plotly_folder_dir()
+):
     """
     Short helper function to display a plotly figure stored in a json file.
 

{detquantlib-3.7.1 → detquantlib-3.8.0}/detquantlib/outputs/outputs_interface.py

@@ -1,5 +1,6 @@
 # Python built-in packages
 import json
+import os
 from pathlib import Path
 
 # Third-party packages
@@ -149,7 +150,14 @@ class OutputSet:
             output_items = list()
         self.output_items = output_items
 
-    def add_item(self, data, filename: str, extension: str, sub_path: str = None):
+    def add_item(
+        self,
+        data,
+        filename: str,
+        extension: str,
+        sub_path: str = None,
+        export_options: dict = None,
+    ):
         """
         Creates an OutputItem object and adds it to the OutputSet list.
 
@@ -159,9 +167,16 @@ class OutputSet:
             extension: File extension to be used when exporting the output data
             sub_path: Within the output base directory, indicates the sub-path (if any) of the
                 folder where the output data should be exported
+            export_options: Additional options for the function exporting the output data to a file
         """
         # Create OutputItem object
-        item = OutputItem(data=data, filename=filename, extension=extension, sub_path=sub_path)
+        item = OutputItem(
+            data=data,
+            filename=filename,
+            extension=extension,
+            sub_path=sub_path,
+            export_options=export_options,
+        )
         # Append to OutputSet list
         self.output_items.append(item)
 
@@ -170,20 +185,28 @@ class PathDefinitions:
     """A class containing hard-coded path definitions."""
 
     @staticmethod
-    def outputs_folder():
+    def default_outputs_folder_name():
         return "Outputs"
 
     @staticmethod
-    def outputs_plotly_folder():
+    def outputs_plotly_folder_name():
         return "PlotlyFigures"
 
+    @staticmethod
+    def get_outputs_folder_name():
+        # Get name from environment variable if it exists, otherwise use default name
+        folder_name = os.getenv("OUTPUTS_FOLDER")
+        if folder_name is None:
+            folder_name = PathDefinitions.default_outputs_folder_name()
+        return folder_name
+
     @staticmethod
     def get_outputs_folder_dir():
         # Base directory of the folder containing all model outputs
-        return Path.cwd().joinpath(PathDefinitions.outputs_folder())
+        return Path.cwd().joinpath(PathDefinitions.get_outputs_folder_name())
 
     @staticmethod
     def get_outputs_plotly_folder_dir():
         # Directory of the output folder containing all plotly figures
         base_dir = PathDefinitions.get_outputs_folder_dir()
-        return base_dir.joinpath(PathDefinitions.outputs_plotly_folder())
+        return base_dir.joinpath(PathDefinitions.outputs_plotly_folder_name())

{detquantlib-3.7.1 → detquantlib-3.8.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "detquantlib"
-version = "3.7.1"
+version = "3.8.0"
 description = "An internal library containing functions and classes that can be used across Quant models."
 authors = ["DET"]
 readme = "README.md"
@@ -11,10 +11,10 @@ packages = [
 
 [tool.poetry.dependencies]
 python = ">=3.10,<4.0"
-paramiko = "^3.5.1"
+paramiko = "^4.0.0"
 numpy = "^2.2.6"
-pandas = "^2.3.0"
-plotly = "^6.1.2"
+pandas = "^2.3.3"
+plotly = "^6.3.1"
 pyodbc = "^5.2.0"
 python-dotenv = "^1.1.0"
 scipy = "^1.15.2"
@@ -22,13 +22,13 @@ scipy = "^1.15.2"
 [tool.poetry.group.dev.dependencies]
 toml = "^0.10.2"
 invoke = "^2.2.0"
-pytest = "^8.3.4"
-pytest-cov = "^6.2.1"
-black = "^25.1.0"
+pytest = "^8.4.2"
+pytest-cov = "^7.0.0"
+black = "^25.9.0"
 darglint = "^1.8.1"
-isort = "^6.0.1"
+isort = "^6.1.0"
 colorama = "^0.4.6"
-pymarkdownlnt = "^0.9.30"
+pymarkdownlnt = "^0.9.32"
 md-toc = "^9.0.0"
 
 [build-system]