rpy-bridge 0.5.0__py3-none-any.whl → 0.5.1__py3-none-any.whl

{rpy_bridge-0.5.0.dist-info → rpy_bridge-0.5.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: rpy-bridge
-Version: 0.5.0
+Version: 0.5.1
 Summary: Python-to-R interoperability engine with environment management, type-safe conversions, data normalization, and safe R function execution.
 Author-email: Victoria Cheung <victoriakcheung@gmail.com>
 License: MIT License
@@ -52,6 +52,12 @@ Provides-Extra: r
 Requires-Dist: rpy2>=3.5; extra == "r"
 Provides-Extra: dev
 Requires-Dist: ipykernel>=7.1.0; extra == "dev"
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: build>=1.0; extra == "dev"
+Requires-Dist: twine>=4.0; extra == "dev"
+Requires-Dist: certifi>=2025.0; extra == "dev"
+Requires-Dist: ty>=0.0.1a34; extra == "dev"
 Provides-Extra: docs
 Requires-Dist: sphinx; extra == "docs"
 Requires-Dist: myst-parser; extra == "docs"
@@ -59,17 +65,11 @@ Dynamic: license-file
 
 # rpy-bridge
 
-**rpy-bridge** is a Python-controlled **R execution orchestrator** that enables
-Python code to run R functions, scripts, and packages with **reproducible
-filesystem and environment semantics**.
-
-It is built on top of `rpy2`, but unlike thin wrappers, rpy-bridge stabilizes how
-R code is executed when invoked from Python: project roots are inferred, `renv`
-environments can be activated out-of-tree, relative paths behave as expected,
-and return values are normalized for safe Python consumption.
-
-This makes rpy-bridge suitable for production pipelines, CI, and bilingual
-Python/R teams where R code must run reliably outside an interactive R session.
+**rpy-bridge** is a Python-controlled **R execution orchestrator** (not a thin
+rpy2 wrapper). It delivers deterministic, headless-safe R startup; project-root
+inference; out-of-tree `renv` activation; isolated script namespaces; and robust
+Python↔R conversions with dtype/NA normalization. Use it when you need
+reproducible R execution from Python in production pipelines and CI.
 
 **Latest release:** [`rpy-bridge` on PyPI](https://pypi.org/project/rpy-bridge/)
 
@@ -77,20 +77,40 @@ Python/R teams where R code must run reliably outside an interactive R session.
 
 ## What this is (and is not)
 
-rpy-bridge **is not a thin rpy2 wrapper**.
+rpy-bridge **is not a thin rpy2 wrapper**. Key differences:
 
-Typical rpy2 usage assumes:
-- the Python working directory is the R project root
-- `renv` lives next to the executing script
-- relative paths resolve correctly by default
-- all R code executes in `globalenv()`
+- Infers R project roots via markers (`.git`, `.Rproj`, `renv.lock`, `DESCRIPTION`, `.here`)
+- Activates `renv` even when it lives outside the calling directory
+- Executes from the inferred project root so relative paths behave as R expects
+- Runs headless by default (no GUI probing), isolates scripts from `globalenv()`
+- Normalizes return values for Python (NAs, dtypes, data.frames) and offers comparison helpers
 
-These assumptions break quickly in real-world Python workflows.
+---
 
-rpy-bridge instead provides a **controlled R runtime** with explicit guarantees
-around execution context, filesystem behavior, and environment activation.
+## Quickstart
 
----
+Call a package function (no scripts):
+
+```python
+from rpy_bridge import RFunctionCaller
+
+rfc = RFunctionCaller()
+samples = rfc.call("stats::rnorm", 5, mean=0, sd=1)
+median_val = rfc.call("stats::median", samples)
+```
+
+Call a function from a local script with `renv` (out-of-tree allowed):
+
+```python
+from pathlib import Path
+from rpy_bridge import RFunctionCaller
+
+project_dir = Path("/path/to/your-r-project")
+script = project_dir / "scripts" / "example.R"
+
+rfc = RFunctionCaller(path_to_renv=project_dir, scripts=script)
+result = rfc.call("some_function", 42, named_arg="value")
+```
 
 ## Core capabilities
 
@@ -161,7 +181,7 @@ reproducibility and avoid side effects during execution.
 ### Prerequisites
 
 - System R installed and available on `PATH`
-- Python 3.12+
+- Python 3.11+ (tested on 3.11–3.12)
 
 ### From PyPI
 
@@ -199,33 +219,7 @@ uv sync
 
 ## Usage
 
-### Call a function from a local R script
-
-```python
-from pathlib import Path
-from rpy_bridge import RFunctionCaller
-
-project_dir = Path("/path/to/your-r-project")
-script = project_dir / "scripts" / "example.R"
-
-caller = RFunctionCaller(
-    path_to_renv=project_dir,
-    script_path=script,
-)
-
-result = caller.call("some_function", 42, named_arg="value")
-```
-
-### Call base R functions (no local script)
-
-```python
-from rpy_bridge import RFunctionCaller
-
-caller = RFunctionCaller(path_to_renv=None)
-
-samples = caller.call("stats::rnorm", 10, mean=0, sd=1)
-median_val = caller.call("stats::median", samples)
-```
+See Quickstart above and examples in `examples/basic_usage.py`.
 
 ---
 

{rpy_bridge-0.5.0.dist-info → rpy_bridge-0.5.1.dist-info}/RECORD

@@ -8,8 +8,8 @@ rpy_bridge/logging.py,sha256=9U2RJHmxLqrXEwS38TkrSqeETXxn1AAfL8BGTjnzSGY,1360
 rpy_bridge/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rpy_bridge/renv.py,sha256=BYBFXP8SslKzD-GZ0yi7T-nMwqcIx2hYPY3BC_xSSZU,4511
 rpy_bridge/rpy2_loader.py,sha256=rQEnAiJbzkTzb4UlcOsG8D4MXZ0LWtYLMP8DequBNzg,1874
-rpy_bridge-0.5.0.dist-info/licenses/LICENSE,sha256=JwbWVcSfeoLfZ2M_ZiyygKVDvhBDW3zbqTWwXOJwmrA,1276
-rpy_bridge-0.5.0.dist-info/METADATA,sha256=6bkzCM7gFr1gtOUF007Zrhhjy9vvNtduX9Vq4o7_YN4,10188
-rpy_bridge-0.5.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-rpy_bridge-0.5.0.dist-info/top_level.txt,sha256=z9UZ77ZuUPoLqMDQEpP4btstsaM1IpXb9Cn9yBVaHmU,11
-rpy_bridge-0.5.0.dist-info/RECORD,,
+rpy_bridge-0.5.1.dist-info/licenses/LICENSE,sha256=JwbWVcSfeoLfZ2M_ZiyygKVDvhBDW3zbqTWwXOJwmrA,1276
+rpy_bridge-0.5.1.dist-info/METADATA,sha256=6AbvKbd8fOgmfoRn2s5D2tqFo_vkZjK4S-eKhRJbNEw,10256
+rpy_bridge-0.5.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+rpy_bridge-0.5.1.dist-info/top_level.txt,sha256=z9UZ77ZuUPoLqMDQEpP4btstsaM1IpXb9Cn9yBVaHmU,11
+rpy_bridge-0.5.1.dist-info/RECORD,,