py-paramstream 0.0.1__tar.gz

py_paramstream-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Benjamin Vallin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

py_paramstream-0.0.1/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.4
+Name: py-paramstream
+Version: 0.0.1
+Summary: Python wrapper for the R package param.stream
+Author-email: Benjamin Vallin <ben.vallin@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Benjamin Vallin
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/benvallin/py-paramstream
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Intended Audience :: Science/Research
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rpy2>=3.5
+Requires-Dist: pandas>=1.5
+Dynamic: license-file
+
+# ***paramstream***
+
+**A Python wrapper for the R package param.stream**
+
+
+---
+
+
+## Requirements
+
+- Python >= 3.9
+- R >= 4.x
+- R package `param.stream` installed
+
+Install R package:
+
+```r
+devtools::install_github("benvallin/param.stream")
+
+```
+
+---

py_paramstream-0.0.1/README.md

@@ -0,0 +1,22 @@
+# ***paramstream***
+
+**A Python wrapper for the R package param.stream**
+
+
+---
+
+
+## Requirements
+
+- Python >= 3.9
+- R >= 4.x
+- R package `param.stream` installed
+
+Install R package:
+
+```r
+devtools::install_github("benvallin/param.stream")
+
+```
+
+---

py_paramstream-0.0.1/pyproject.toml

@@ -0,0 +1,32 @@
+[project]
+name = "py-paramstream"
+version = "0.0.1"
+description = "Python wrapper for the R package param.stream"
+readme = "README.md"
+requires-python = ">=3.9"
+license = { file = "LICENSE" }
+authors = [{ name = "Benjamin Vallin", email = "ben.vallin@gmail.com" }]
+
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Operating System :: OS Independent",
+  "License :: OSI Approved :: MIT License",
+  "Intended Audience :: Science/Research",
+]
+
+dependencies = [
+  "rpy2>=3.5",
+  "pandas>=1.5"
+]
+
+[project.urls]
+Homepage = "https://github.com/benvallin/py-paramstream"
+
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+

py_paramstream-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

py_paramstream-0.0.1/src/paramstream/__init__.py

@@ -0,0 +1,25 @@
+"""
+Python wrapper for the R package `param.stream`.
+"""
+
+from .core import (
+  get_params_log_id_from_dict,
+  write_params_log_from_dict,
+  get_params_log_table
+  )
+
+__all__ = [
+  'get_params_log_id_from_dict',
+  'write_params_log_from_dict',
+  'get_params_log_table'
+  ]
+
+from importlib.metadata import version, PackageNotFoundError
+
+try:
+  
+  __version__ = version('paramstream')
+  
+except PackageNotFoundError:
+  
+  __version__ = 'unknown'

py_paramstream-0.0.1/src/paramstream/_conversion.py

@@ -0,0 +1,120 @@
+# %% Set up ----
+
+# Import required libraries
+from typing import Union, TypeAlias
+import pandas as pd
+from rpy2.robjects.packages import importr
+from rpy2.robjects.vectors import StrVector, BoolVector, FloatVector, IntVector, ListVector
+from rpy2.robjects import NULL
+from rpy2.robjects import RObject
+from rpy2.rinterface import NULLType
+
+# %% _get_paramstream_r() ----
+
+def _get_paramstream_r():
+  
+  try:
+    
+    return importr('param.stream')
+  
+  except Exception as e:
+    
+    raise ImportError(
+      "R package 'param.stream' is not installed or R is not available."
+      ) from e
+        
+# %% _py_to_r() ----
+
+PyScalar: TypeAlias = Union[str, int, float, bool]
+PyValue: TypeAlias = Union[
+    None,
+    PyScalar,
+    list['PyValue'],
+    dict[str, 'PyValue'],
+]
+
+def _py_to_r(obj: PyValue) -> Union[RObject, NULLType]:
+  
+  """Convert a supported Python object into the corresponding rpy2 R object
+  
+  Supported conversions:
+    None            -> R NULL
+    bool            -> logical vector (length 1)
+    str             -> character vector (length 1)
+    int             -> integer vector (length 1)
+    float           -> numeric vector (length 1)
+    list[str]       -> character vector
+    list[bool]      -> logical vector
+    list[int]       -> integer vector
+    list[float]     -> numeric vector
+    list[mixed]     -> R list (recursive conversion)
+    dict            -> named R list (recursive conversion)
+
+  Lists and dictionaries are converted recursively.
+
+  Parameters
+  ----------
+  obj : Any 
+      Python object to convert.
+
+  Returns
+  -------
+  rpy2.robjects.RObject or rpy2.robjects.NULL
+      Equivalent R representation.
+
+  Raises
+  ------
+  TypeError
+      If the object type is not supported.
+      
+  """
+  
+  if obj is None:
+    
+    return NULL
+  
+  if isinstance(obj, bool):
+    
+    return BoolVector([obj])
+
+  if isinstance(obj, str):      
+    
+    return StrVector([obj])
+  
+  if isinstance(obj, int):
+    
+    return IntVector([obj])
+  
+  if isinstance(obj, float):
+    
+    return FloatVector([obj])
+  
+  if isinstance(obj, list):
+    
+    if len(obj) == 0:
+      
+      return ListVector({})
+    
+    if all(isinstance(x, str) for x in obj):
+      
+      return StrVector(obj)
+    
+    if all(isinstance(x, bool) for x in obj):
+      
+      return BoolVector(obj)
+    
+    if all(isinstance(x, int) for x in obj):
+      
+      return IntVector(obj)
+    
+    if all(isinstance(x, float) for x in obj):
+      
+      return FloatVector(obj)
+    
+    return ListVector({str(i): _py_to_r(v) for i, v in enumerate(obj)})
+  
+  if isinstance(obj, dict):
+    
+    return ListVector({k: _py_to_r(v) for k, v in obj.items()})
+  
+  raise TypeError(f'Unsupported type: {type(obj)}')

py_paramstream-0.0.1/src/paramstream/core.py

@@ -0,0 +1,147 @@
+# %% Set up ----
+
+# Import required libraries
+from typing import Optional
+import pandas as pd
+from rpy2.robjects.conversion import localconverter, rpy2py
+from rpy2.robjects.pandas2ri import converter
+from ._conversion import _get_paramstream_r, _py_to_r
+
+# %% get_params_log_id_from_dict() ----
+
+def get_params_log_id_from_dict(params_dict: dict, in_dir_path: str) -> str:
+  
+  """Get log ID from parameters dict
+  
+  This function is a Python wrapper around param.stream::get_params_log_id_from_list().
+  It converts Python objects to their R equivalents before calling the underlying R function.
+
+  Parameters
+  ----------
+  params_dict: dict
+      Dictionary mapping parameter names to values. Values must be scalars (str, int, float, bool), lists of homogeneous scalars, or None.
+  in_dir_path: str
+      Path to the directory containing the params.log file.
+
+  Returns
+  -------
+  str
+      The log ID matching <params_list> in the params.log file at <in_dir_path>.
+  
+  Raises
+  ------
+  TypeError
+      If <params_dict> contains unsupported value types.
+  rpy2.rinterface_lib.embedded.RRuntimeError
+      If the underlying R function raises an error.
+      
+  """
+  
+  _paramstream_r = _get_paramstream_r()
+  
+  params_list_r = _py_to_r(params_dict)
+  in_dir_path_r = _py_to_r(in_dir_path)
+  
+  output_r = _paramstream_r.get_params_log_id_from_list(
+    params_list=params_list_r, 
+    in_dir_path=in_dir_path_r
+    )
+    
+  return output_r[0]
+
+# %% write_params_log_from_dict() ----
+
+def write_params_log_from_dict(params_dict: dict, out_dir_path: str, params_log_table: bool = True) -> Optional[pd.DataFrame]:
+  
+  """Write parameters log file from parameters dict
+  
+  This function is a Python wrapper around param.stream::write_params_log_from_list().
+  It converts Python objects to their R equivalents before calling the underlying R function.
+
+  Parameters
+  ----------
+  params_dict: dict
+      Dictionary mapping parameter names to values. Values must be scalars (str, int, float, bool), lists of homogeneous scalars, or None.
+  out_dir_path: str
+      Path to the directory where the params.log file should be written.
+  params_log_table: bool, default=True
+      If True, return the params log table as a pandas DataFrame.
+      If False, no value is returned.
+
+  Returns
+  -------
+  pd.DataFrame or None
+      The params log table if <params_log_table> is True.
+  
+  Raises
+  ------
+  TypeError
+      If <params_dict> contains unsupported value types.
+  rpy2.rinterface_lib.embedded.RRuntimeError
+      If the underlying R function raises an error.
+      
+  """
+  _paramstream_r = _get_paramstream_r()
+  
+  params_list_r = _py_to_r(params_dict)
+  out_dir_path_r = _py_to_r(out_dir_path)
+  params_log_table_r = _py_to_r(params_log_table)
+  
+  output_r = _paramstream_r.write_params_log_from_list(
+    params_list=params_list_r, 
+    out_dir_path=out_dir_path_r,
+    params_log_table=params_log_table_r
+    )
+  
+  if params_log_table is False:
+    
+    return
+  
+  else:
+    
+    with localconverter(converter):
+      
+      return rpy2py(output_r)
+
+# %% get_params_log_table() ----
+
+def get_params_log_table(log_id: str, in_dir_path: str) -> pd.DataFrame:
+  
+  """Get parameters log table from log ID
+  
+  This function is a Python wrapper around param.stream::get_params_log_table().
+  It converts Python objects to their R equivalents before calling the underlying R function.
+
+  Parameters
+  ----------
+  log_id: str
+      log ID for which the log table should be returned.
+  in_dir_path: str
+      Path to the directory containing the params.log file.
+
+  Returns
+  -------
+  pd.DataFrame
+      The params log table matching the input <log_id>.
+  
+  Raises
+  ------
+  rpy2.rinterface_lib.embedded.RRuntimeError
+      If the underlying R function raises an error.
+      
+  """
+  
+  _paramstream_r = _get_paramstream_r()
+  
+  log_id_r = _py_to_r(log_id)
+  in_dir_path_r = _py_to_r(in_dir_path)
+  
+  output_r = _paramstream_r.get_params_log_table(
+    log_id=log_id_r, 
+    in_dir_path=in_dir_path_r
+    )
+  
+  with localconverter(converter):
+    
+    return rpy2py(output_r)
+

py_paramstream-0.0.1/src/py_paramstream.egg-info/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.4
+Name: py-paramstream
+Version: 0.0.1
+Summary: Python wrapper for the R package param.stream
+Author-email: Benjamin Vallin <ben.vallin@gmail.com>
+License: MIT License
+        
+        Copyright (c) 2026 Benjamin Vallin
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/benvallin/py-paramstream
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Operating System :: OS Independent
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Intended Audience :: Science/Research
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rpy2>=3.5
+Requires-Dist: pandas>=1.5
+Dynamic: license-file
+
+# ***paramstream***
+
+**A Python wrapper for the R package param.stream**
+
+
+---
+
+
+## Requirements
+
+- Python >= 3.9
+- R >= 4.x
+- R package `param.stream` installed
+
+Install R package:
+
+```r
+devtools::install_github("benvallin/param.stream")
+
+```
+
+---

py_paramstream-0.0.1/src/py_paramstream.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+src/paramstream/__init__.py
+src/paramstream/_conversion.py
+src/paramstream/core.py
+src/py_paramstream.egg-info/PKG-INFO
+src/py_paramstream.egg-info/SOURCES.txt
+src/py_paramstream.egg-info/dependency_links.txt
+src/py_paramstream.egg-info/requires.txt
+src/py_paramstream.egg-info/top_level.txt

py_paramstream-0.0.1/src/py_paramstream.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

py_paramstream-0.0.1/src/py_paramstream.egg-info/requires.txt

@@ -0,0 +1,2 @@
+rpy2>=3.5
+pandas>=1.5

py_paramstream-0.0.1/src/py_paramstream.egg-info/top_level.txt

@@ -0,0 +1 @@
+paramstream