v1.3.0

Author: nikolarobottesla

CHANGELOG.md

@@ -4,6 +4,15 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
+## [1.3.0] - 2025-09-25
+
+### Added
+- ability to pass any plotly keyword arguments e.g. 'font' and or 'legend' via `update_layout_kwargs`
+
+### Changed
+- useability improvement: space characters are stripped from x_id, y_id and also from the loaded dataframe column headers therefore leading and trailing spaces no longer create errors
+
 ## [1.2.0] - 2025-09-05
 
 ### Added

README.md

@@ -17,6 +17,7 @@ Plotme takes tabular data (e.g. excel) and outputs interactive scatter plots. It
     * error bars
     * axes kwargs
   * [pio.templates](https://plotly.com/python/templates/)
+  * pass any plotly keyword arguments e.g. 'font' and or 'legend' `update_layout_kwargs`
 * auto-detect data files (xls, xlsx, csv only)
 * supported data files: xls, xlsx, csv, txt
 * filter data files (include and exclude) `folder_include_filter`, `folder_exclude_filter`, 
@@ -45,6 +46,42 @@ Plotme takes tabular data (e.g. excel) and outputs interactive scatter plots. It
   3. modify the template as needed
   4. run again to generate plot(s)
 
+
+### example JSON plot_info.json file
+in this example
+* the x value is extracted from the file name via regular expression
+* each point on the scatter plot is the maximum value from a column called `Force(N)-data` where the header is located at the 4th row of a data file
+* the legend is inside the plot in the right top corner, by default the legend is outside the plot on the right side
+```json
+{
+    "title_text": "Force over temperature",
+    "x_id": "_(\\d+)C",
+    "x_title": "Temperature (C)",
+    "y_id": "Force(N)-data",
+    "y_title": "Max Force (N)",
+    "showlegend": true,
+    "update_layout_args": {
+        "legend": {"xanchor": "right", "yanchor": "top"},
+        "font": {"size": 17}
+    },
+    "x_axes_kwargs": {
+        "type": "-"
+    },
+    "y_axes_kwargs": {
+        "type": "log"
+    },
+    "xaxes_visible": true,
+    "yaxes_visible": true,
+    "schema": {
+        "header": 3,
+        "x_id_is_reg_exp": true
+    },
+    "post": "max",
+    "pio.template": "plotly_white",
+    "trace_mode": "markers"
+}
+```
+
 ## Contribute
 
 ### unimplemented ideas, in order of priority

plotme/__init__.py

@@ -1,5 +1,5 @@
 import os
 
-__version__ = '1.2.0'
+__version__ = '1.3.0'
 
 os.environ['PLOTME_VERSION'] = __version__

plotme/helper.py

@@ -53,3 +53,29 @@ def start_logging(log_folder='', log_level=logging.INFO, file_name='',
         logging.info('info logging active')
         logging.warning('warning logging active')
         logging.error('error logging active')
+
+
+def strip_white_space(string_or_strings):
+    """
+    Strips leading and trailing white space from a string or any iterable of strings
+
+    Parameters
+    ----------
+    string_or_strings: str or iterable
+        string or iterable of strings to be stripped
+
+    Returns
+    -------
+    str or same type as input
+        stripped string or iterable of stripped strings
+    """
+    if isinstance(string_or_strings, str):
+        return string_or_strings.strip()
+    else:
+        try:
+            # Try to iterate over the input
+            stripped_items = [s.strip() for s in string_or_strings]
+            # Return the same type as input (list, tuple, etc.)
+            return type(string_or_strings)(stripped_items)
+        except TypeError:
+            raise ValueError(f"Unexpected type: {type(string_or_strings)}, expected str or iterable")

plotme/load_data.py

@@ -153,6 +153,9 @@ def __init__(self, directory, x_id='', y_id='', args_dict={}):
                 file_info = {'file_stem' : file_path.stem,
                              'file_path': str(file_path)}
                 df = read(file, index_col=index_col, header=header)
+
+                # strip only beginning and ending white space from column headers
+                df.columns = df.columns.str.strip()
 
                 # if x_id or y_id not a columns header, try to fuzzy match it
                 # if matching doesn't work then skip the file

plotme/plotting.py

@@ -10,6 +10,7 @@
 from jsonschema import validate
 from plotly.subplots import make_subplots
 
+from plotme.helper import strip_white_space
 from plotme.load_data import Folder, check_filter_match
 from plotme.schema import schema, template
 
@@ -88,12 +89,15 @@ def single_plot(args_dict={}):
 
     title = args_dict.get('title_text', 'plotme plot')
     x_id = args_dict.get('x_id', 'index')
+    x_id = strip_white_space(x_id)
     x_title = args_dict.get('x_title', x_id)  # use x_id if no label is given
     y_id = args_dict.get('y_id', 'headers')
+    y_id = strip_white_space(y_id)
     y_title = args_dict.get('y_title', y_id)  # use y_id if no label is given
     trace_mode = args_dict.get('trace_mode', 'markers')
     marker_symbols = args_dict.get('marker_symbols')
     show_legend = args_dict.get('showlegend', True)
+    update_layout_kwargs = args_dict.get('update_layout_args', {})
     x_axes_kwargs = args_dict.get('x_axes_kwargs', {})
     y_axes_kwargs = args_dict.get('y_axes_kwargs', {})
     x_axes_visible = args_dict.get('xaxes_visible', True)
@@ -203,6 +207,7 @@ def single_plot(args_dict={}):
 
     fig.update_layout(height=height, width=width, title_text=title)
     fig.update_layout(showlegend=show_legend)
+    fig.update_layout(**update_layout_kwargs)
     fig.update_xaxes(visible=x_axes_visible, **x_axes_kwargs)
     fig.update_yaxes(visible=y_axes_visible, **y_axes_kwargs)
 

plotme/schema.py

@@ -8,6 +8,7 @@
             "y_title": {"type": "string"},
             "y_id": {"type": ["array", "string"], "items": {"type": "string"}},
             "showlegend": {"type": "boolean"},
+            "update_layout_kwargs": {"type": "object"},
             "xaxes_visible": {"type": "boolean"},
             "yaxes_visible": {"type": "boolean"},
             "folder_include_filter": {"type": "string"},
@@ -75,6 +76,7 @@
     "y_title": "label in plot, y_id used if unspecified",
     "y_id": ["array of column headers, single column header or column letter"],
     "showlegend": True,
+    "update_layout_kwargs": "pass through any fig.update_layout key word arguments to plotly",
     "xaxes_visible": True,
     "yaxes_visible": True,
     "folder_include_filter": "must be in the folder name, string or array of strings",