sepehr/diagram_ph
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(ipm): ensure remote-readme is English-only (minimal)

Browse Source
This commit is contained in:
Repo Bot 2025-10-19 12:59:06 +02:00
parent ec73a755c2
commit 60f951a823
1 changed files with 7 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
app/ipm/README.md
View File

@ -2,17 +2,14 @@
This folder contains the Python wrapper that calls the native refifc libraries. This folder contains the Python wrapper that calls the native refifc libraries.
Goals Quick summary
- Centralize the Python wrapper under `app/ipm` so application code can import `app.ipm.simple_refrig_api`. - Wrapper import path: `app.ipm.simple_refrig_api`.
- Provide a clear location for native binaries (DLLs for Windows, .so for Linux). - Windows DLLs: place under `app/ipm/lib/windows/`.
- Linux shared objects (.so): place under `app/ipm/lib/linux/`.
Where to place native binaries The wrapper prefers `app/ipm/lib/<platform>` at runtime and falls back to the package directory.
- Windows (local/dev): place DLL files in `app/ipm/lib/windows/`.
- Linux (container/production): place .so files in `app/ipm/lib/linux/`.
The wrapper `app/ipm/simple_refrig_api.py` will look first in `app/ipm/lib/<platform>` (`windows` or `linux`) and fall back to the package directory if nothing is found. Important: native binaries are large and often licensed. Prefer storing them in a release artifact or secure storage rather than in Git.
Do NOT commit native binaries
-------------------------------- --------------------------------
Native binaries should not be committed to the repo (size, licensing, portability). The repo contains a `.gitignore` rule excluding `app/ipm/lib/windows/*.dll`. 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.). - Store binaries in a secure artifact repository (releases, internal storage, S3, etc.).
- During CI, download them and copy into `app/ipm/lib/<platform>` before building the image or deploying. - During CI, download them and copy into `app/ipm/lib/<platform>` before building the image or deploying.
Quick local test Quick local test
1. Copy the binaries into the correct folder (e.g. `app/ipm/lib/windows/refifc.dll`). 1. Copy the binaries into the correct folder (e.g. `app/ipm/lib/windows/refifc.dll`).
2. Test locally: 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'))" .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) For the complete French documentation see: [README_fr.md](README_fr.md)
````markdown ````markdown