direl-ts-tool-kit 0.2.0__tar.gz → 0.2.2__tar.gz

{direl_ts_tool_kit-0.2.0 → direl_ts_tool_kit-0.2.2}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: direl-ts-tool-kit
-Version: 0.2.0
+Version: 0.2.2
 Summary: A toolbox for time series analysis and visualization.
 Home-page: https://gitlab.com/direl/direl_tool_kit
-Author: Tu Nombre Aquí
+Author: Diego Restrepo-Leal
 Author-email: diegorestrepoleal@gmail.com
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
@@ -17,6 +17,7 @@ License-File: LICENCE
 Requires-Dist: pandas>=1.0.0
 Requires-Dist: numpy>=1.18.0
 Requires-Dist: matplotlib>=3.0.0
+Requires-Dist: openpyxl
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

{direl_ts_tool_kit-0.2.0 → direl_ts_tool_kit-0.2.2}/direl_ts_tool_kit/__init__.py

@@ -1,2 +1,3 @@
 from .plot.plot_style import *
 from .plot.plot_ts import *
+from .utilities.data_prep import *

{direl_ts_tool_kit-0.2.0 → direl_ts_tool_kit-0.2.2}/direl_ts_tool_kit/plot/plot_ts.py

@@ -41,6 +41,16 @@ def plot_time_series(
     -----
     Major grid lines are displayed with a dashed line ('--'), and minor grid
     lines are displayed with a dotted line (':') for detailed temporal analysis.
+
+        Available Colors
+    ----------------
+    The 'color' parameter accepts any key from the 'paper_colors' dictionary.
+
+    Lines: 'BLUE_LINES', 'ORANGE_LINES', 'GREEN_LINES', 'RED_LINES',
+           'GRAY_LINES', 'PURPLE_LINES', 'MAROON_LINES', 'GOLD_LINES'.
+
+    Bars:  'BLUE_BARS', 'ORANGE_BARS', 'GREEN_BARS', 'RED_BARS',
+           'GRAY_BARS', 'PURPLE_BARS', 'MAROON_BARS', 'GOLD_BARS'.
     """
 
     fig, ax = plt.subplots()
@@ -97,3 +107,43 @@ def plot_time_series(
     ax.grid(which="major", alpha=0.8, linestyle="--")
 
     return fig
+
+
+def save_figure(
+    fig,
+    file_name,
+    variable_name="",
+    path="./",
+):
+    """
+    Saves a Matplotlib figure in three common high-quality formats (PNG, PDF, SVG).
+
+    The function creates a consistent file name structure:
+    {path}/{file_name}_{variable_name}.{extension}.
+
+    Parameters
+    ----------
+    fig : matplotlib.figure.Figure
+        The Matplotlib figure object to be saved.
+    file_name : str
+        The primary name for the file (e.g., 'timeseries_report').
+    variable_name : str, optional
+        An optional secondary name, often the name of the plotted variable,
+        to be appended to the file name. Defaults to "".
+    path : str, optional
+        The directory path where the figure files will be saved.
+        Defaults to the current directory ('./').
+
+    Returns
+    -------
+    None
+    """
+
+    if variable_name:
+        base_name = f"{path}/{file_name}_{variable_name}"
+    else:
+        base_name = f"{path}/{file_name}"
+
+    fig.savefig(f"{base_name}.png")
+    fig.savefig(f"{base_name}.pdf")
+    fig.savefig(f"{base_name}.svg")

direl_ts_tool_kit-0.2.2/direl_ts_tool_kit/utilities/__init__.py

@@ -0,0 +1 @@
+from .data_prep import *

direl_ts_tool_kit-0.2.2/direl_ts_tool_kit/utilities/data_prep.py

@@ -0,0 +1,35 @@
+import pandas as pd
+
+
+def parse_datetime_index(df_raw, date_column="date"):
+    """
+    Parses a specified column into datetime objects and sets it as the DataFrame index.
+
+    This function is crucial for preparing raw data (df_raw) for time series analysis
+    by ensuring the DataFrame is indexed by the correct datetime type.
+
+    Parameters
+    ----------
+    df_raw : pd.DataFrame
+        The raw DataFrame containing the data, including the column with date strings.
+    date_column : str, optional
+        The name of the column in 'df_raw' that contains the date/time information.
+        Defaults to "date".
+
+    Returns
+    -------
+    df_ts : pd.DataFrame
+        A copy of the original DataFrame with the specified date column removed
+        and set as the DatetimeIndex. Ready for time series plotting.
+    original_dates : pd.Series
+        The original Series containing the date strings/objects, which was used
+        to create the new index.
+    """
+
+    date_parsed = pd.to_datetime(df_raw[date_column])
+    df_ts = df_raw.copy()
+    original_dates = df_raw[date_column]
+    df_ts.drop(columns=[date_column], inplace=True)
+    df_ts.set_index(date_parsed, inplace=True)
+
+    return df_ts, original_dates

{direl_ts_tool_kit-0.2.0 → direl_ts_tool_kit-0.2.2}/direl_ts_tool_kit.egg-info/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: direl-ts-tool-kit
-Version: 0.2.0
+Version: 0.2.2
 Summary: A toolbox for time series analysis and visualization.
 Home-page: https://gitlab.com/direl/direl_tool_kit
-Author: Tu Nombre Aquí
+Author: Diego Restrepo-Leal
 Author-email: diegorestrepoleal@gmail.com
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
@@ -17,6 +17,7 @@ License-File: LICENCE
 Requires-Dist: pandas>=1.0.0
 Requires-Dist: numpy>=1.18.0
 Requires-Dist: matplotlib>=3.0.0
+Requires-Dist: openpyxl
 Dynamic: author
 Dynamic: author-email
 Dynamic: classifier

{direl_ts_tool_kit-0.2.0 → direl_ts_tool_kit-0.2.2}/direl_ts_tool_kit.egg-info/SOURCES.txt

@@ -9,4 +9,6 @@ direl_ts_tool_kit.egg-info/requires.txt
 direl_ts_tool_kit.egg-info/top_level.txt
 direl_ts_tool_kit/plot/__init__.py
 direl_ts_tool_kit/plot/plot_style.py
-direl_ts_tool_kit/plot/plot_ts.py
+direl_ts_tool_kit/plot/plot_ts.py
+direl_ts_tool_kit/utilities/__init__.py
+direl_ts_tool_kit/utilities/data_prep.py

{direl_ts_tool_kit-0.2.0 → direl_ts_tool_kit-0.2.2}/direl_ts_tool_kit.egg-info/requires.txt

@@ -1,3 +1,4 @@
 pandas>=1.0.0
 numpy>=1.18.0
 matplotlib>=3.0.0
+openpyxl

{direl_ts_tool_kit-0.2.0 → direl_ts_tool_kit-0.2.2}/setup.py

@@ -2,11 +2,11 @@ from setuptools import setup, find_packages
 
 setup(
     name="direl-ts-tool-kit",
-    version="0.2.0",
+    version="0.2.2",
     description="A toolbox for time series analysis and visualization.",
     long_description=open("README.md", encoding="utf-8").read(),
     long_description_content_type="text/markdown",
-    author="Tu Nombre Aquí",
+    author="Diego Restrepo-Leal",
     author_email="diegorestrepoleal@gmail.com",
     url="https://gitlab.com/direl/direl_tool_kit",
     packages=find_packages(),
@@ -14,6 +14,7 @@ setup(
         "pandas>=1.0.0",
         "numpy>=1.18.0",
         "matplotlib>=3.0.0",
+        "openpyxl",
     ],
     classifiers=[
         "Programming Language :: Python :: 3",