From 60f951a8231661ddfda082cf6e30dd59aa0cbda2 Mon Sep 17 00:00:00 2001 From: Repo Bot Date: Sun, 19 Oct 2025 12:59:06 +0200 Subject: [PATCH] docs(ipm): ensure remote-readme is English-only (minimal) --- app/ipm/README.md | 21 +++++++-------------- 1 file changed, 7 insertions(+), 14 deletions(-) diff --git a/app/ipm/README.md b/app/ipm/README.md index e6869f9..e0b2c4c 100644 --- a/app/ipm/README.md +++ b/app/ipm/README.md @@ -2,17 +2,14 @@ This folder contains the Python wrapper that calls the native refifc libraries. -Goals -- Centralize the Python wrapper under `app/ipm` so application code can import `app.ipm.simple_refrig_api`. -- Provide a clear location for native binaries (DLLs for Windows, .so for Linux). +Quick summary +- Wrapper import path: `app.ipm.simple_refrig_api`. +- Windows DLLs: place under `app/ipm/lib/windows/`. +- Linux shared objects (.so): place under `app/ipm/lib/linux/`. -Where to place native binaries -- Windows (local/dev): place DLL files in `app/ipm/lib/windows/`. -- Linux (container/production): place .so files in `app/ipm/lib/linux/`. +The wrapper prefers `app/ipm/lib/` at runtime and falls back to the package directory. -The wrapper `app/ipm/simple_refrig_api.py` will look first in `app/ipm/lib/` (`windows` or `linux`) and fall back to the package directory if nothing is found. - -Do NOT commit native binaries +Important: native binaries are large and often licensed. Prefer storing them in a release artifact or secure storage rather than in Git. -------------------------------- Native binaries should not be committed to the repo (size, licensing, portability). The repo contains a `.gitignore` rule excluding `app/ipm/lib/windows/*.dll`. @@ -20,6 +17,7 @@ CI/CD - Store binaries in a secure artifact repository (releases, internal storage, S3, etc.). - During CI, download them and copy into `app/ipm/lib/` before building the image or deploying. + Quick local test 1. Copy the binaries into the correct folder (e.g. `app/ipm/lib/windows/refifc.dll`). 2. Test locally: @@ -28,11 +26,6 @@ Quick local test .venv\Scripts\python -c "import app.ipm.simple_refrig_api as s; r=s.Refifc('R290'); print('hsl_px exists', hasattr(r,'hsl_px'))" ``` -Best practices -- Avoid committing binaries in Git unless necessary for your release process. -- Record the exact origin and version of native binaries in release notes. -- Provide small helper scripts (`scripts/copy-ipm-libs.*`) to automate copying binaries into build environments. - For the complete French documentation see: [README_fr.md](README_fr.md) ````markdown