robotframework-sapfx 0.6.4__tar.gz

robotframework_sapfx-0.6.4/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

robotframework_sapfx-0.6.4/NOTICE

@@ -0,0 +1,92 @@
+SAPFX (robotframework-sapfx)
+Copyright 2026 Cyril Montiel
+
+This product includes software developed as part of:
+
+  robotframework-sapguilibrary
+  Copyright (c) Frank van der Kuur
+  https://github.com/frankvanderkuur/robotframework-sapguilibrary
+  Licensed under the Apache License, Version 2.0.
+
+The file `src/SapEccLibrary/_vendor/sapgui_base.py` is a vendored copy of that
+project's `SapGuiLibrary.py`, with the single modification of renaming the class
+`SapGuiLibrary` to `SapGuiBase`. See that file's header for details.
+
+----------------------------------------------------------------------
+
+  playwright-sap
+  Copyright (c) Arpit Sureka
+  https://github.com/ArpitSureka/playwright-sap
+  Licensed under the Apache License, Version 2.0.
+
+The UI5 locator techniques in `src/SapFioriLibrary/_ui5_js.py` and
+`tools/spy_web/ui5_selector_snippet.js` — the control-hierarchy XML tree, the XPath
+engine over it, own+inherited property extraction, the case-insensitive property
+matcher, drilling to the interactable element, and the priority-ordered property
+allowlist — are derived from that project's `packages/injected/src/sap/` and
+`packages/sap/` sources. The code was re-implemented as a single injected JS bundle
+(no Playwright fork) and adapted for Robot Framework. See that file's header.
+
+----------------------------------------------------------------------
+
+  robotframework-robosapiens (RoboSAPiens)
+  Copyright (c) imbus AG / Marduk Bolaños
+  https://github.com/imbus/robotframework-robosapiens
+  Licensed under the Apache License, Version 2.0.
+
+The human-locator techniques in `src/sapfx_common/semantic.py` — targeting SAP
+GUI controls by visible label with geometric proximity (closest label left of /
+above a field, alignment and gap tolerances), label-intersection addressing,
+prefix matching for tooltips ending in keyboard shortcuts, grid/position
+addressing (Nth field in a vertical or horizontal grid below/right of a label),
+and scoped anchoring (narrowing resolution to the neighborhood of a unique
+label to disambiguate a repeated label or a field with no label of its own) —
+are derived from that project's locator strategies (`robosapiens/Locators.cs`,
+`SAPLabel.cs`, `TextFields.cs`, `Position.cs`, `RoboSAPiens.Recorder/
+GuiRecorder.cs`). The code was re-implemented in Python over this project's
+perception model (with explicit ambiguity detection instead of first-match,
+and neighborhood-based scoping instead of their unspecified algorithm) rather
+than ported verbatim. The use of `GuiSession.GetObjectTree` as a
+single-roundtrip perception fast path (`src/sapfx_common/object_tree.py`) was
+also learned from that project's recorder.
+
+The embedded-browser-control bridge in
+`src/SapEccLibrary/keywords/_embedded_browser.py` — enabling WebView2's CDP
+remote debugging via the `WEBVIEW2_ADDITIONAL_BROWSER_ARGUMENTS` environment
+variable, then locating and switching to the hosted page through the Browser
+library (`robotframework-browser`) over CDP — documents and adapts a workflow
+described in that project's README (embedded browser control automation via
+Browser Library); no code was copied, only the workflow.
+
+Two further ideas were learned from that project's recorder (studied 2026-08,
+`RoboSAPiens.Recorder/GuiRecorder.cs`): generating a standalone HTML
+documentation report from a recording (their `saveHtmlReport`; re-implemented
+from scratch in `tools/recorder/sapgui_recorder.py` — `steps_to_report` — and
+in the web recorder of `src/SapFioriLibrary/_ui5_js.py`, per-step with our own
+business phrasing and inline data-URI screenshots, no template engine and no
+code ported), and resolving virtual-key names through the scripting API's
+`GuiSession.GetVKeyDescription` instead of a hand-maintained table (used as an
+optional extension of this project's static vkey table).
+
+----------------------------------------------------------------------
+
+  playwright-praman
+  Copyright (c) mrkanitkar (playwright-praman contributors)
+  https://github.com/mrkanitkar/playwright-praman
+  Licensed under the Apache License, Version 2.0.
+
+Three concepts in this project are derived from that project's design (studied
+2026-07): the business-vocabulary system in `src/sapfx_common/vocabulary.py`
+(business terms — canonical name + synonyms + ABAP field — grouped by SAP
+module domain, resolved with tiered/fuzzy scoring and an ambiguity-refusal
+threshold), the Fiori launchpad navigation keywords in
+`src/SapFioriLibrary/SapFioriLibrary.py` (`Open Fiori App` by semantic
+object/action intent hash, tile addressing by title), and the
+identity-provider login-flow presets in `src/sapfx_common/auth_flows.py`
+(recognizing common IDP login forms — SAP IAS, Azure AD — by their field
+selectors and driving single-page and two-step flows generically). All were
+re-implemented from scratch in Python on this project's engines (no code was
+ported); synonyms additionally cover French terms, and ambiguity is always
+surfaced with the candidate list, never resolved by first match.
+
+A copy of the Apache License 2.0 is provided in the LICENSE file.

robotframework_sapfx-0.6.4/PKG-INFO

@@ -0,0 +1,263 @@
+Metadata-Version: 2.4
+Name: robotframework-sapfx
+Version: 0.6.4
+Summary: SAPFX - SAP test automation for Robot Framework: SAP GUI (ECC / S4 backend), Fiori/UI5, OData API. Forked from robotframework-sapguilibrary.
+Author-email: Cyril Montiel <cyril@montiel.me>
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/CyrilM29/robotframework-sapfx
+Project-URL: Upstream, https://github.com/frankvanderkuur/robotframework-sapguilibrary
+Keywords: robotframework,sap,sapgui,ecc,s4hana,test-automation
+Classifier: Framework :: Robot Framework :: Library
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: License :: OSI Approved :: Apache Software License
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: robotframework>=7.4
+Requires-Dist: pywin32>=305; platform_system == "Windows"
+Provides-Extra: web
+Requires-Dist: robotframework-browser>=20.0; extra == "web"
+Provides-Extra: visual
+Requires-Dist: Pillow>=10.0; extra == "visual"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: ruff>=0.4; extra == "dev"
+Requires-Dist: pre-commit>=3.0; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
+Dynamic: license-file
+
+> **🇬🇧 English** · [🇫🇷 Français](README.fr.md)
+
+<p align="center">
+  <img src="assets/logo.png" alt="SAPFX — ECC UI5 API Library &amp; Recorder" width="240">
+</p>
+
+# SAPFX
+
+SAP test automation for Robot Framework (distribution `robotframework-sapfx`)
+with **one business vocabulary across three channels**:
+
+- **`SapEccLibrary`** (phase 1) — SAP GUI thick client (ECC, S/4HANA backend),
+  a hardened fork of
+  [robotframework-sapguilibrary](https://github.com/frankvanderkuur/robotframework-sapguilibrary)
+  (Apache 2.0), over COM.
+- **`SapFioriLibrary`** (phase 2) — SAP Fiori / S/4HANA web (SAPUI5), over Playwright
+  (Browser library) with **UI5-stable control selectors** (no dynamic-id churn):
+  role/property matching *and* a hierarchical **UI5 XPath** engine
+  (`//Table//Button[@text='Edit']`), plus a **WebGUI `sid` engine** for classic
+  SAP GUI for HTML pages and a **Web Components engine** for `ui5-*` pages
+  without a classic UI5 runtime. The locator engine is ported from
+  [playwright-sap](https://github.com/ArpitSureka/playwright-sap) (Apache-2.0).
+- **`SapApiLibrary`** — the API channel (stdlib-only): OData **v2 and v4**
+  behind one keyword set (incl. the SAP CSRF protocol), optional RFC via
+  pyrfc. Prepare and cross-check data through the API; drive the screen only
+  for what you actually test — see the cross-paradigm flagship suite
+  (`tests/robot/flagship_cross_paradigm.robot`: SE16 count == OData `$count`
+  on the same live system).
+
+A test reads the same whichever channel it drives. See
+[docs/architecture.md](docs/architecture.md) and
+[docs/fiori-architecture.md](docs/fiori-architecture.md).
+
+![Live demo: a stale locator healed against a real SAP system, down to the resources patch](https://raw.githubusercontent.com/CyrilM29/robotframework-sapfx/main/docs/media/healing-live.gif)
+
+Everything above is **real**: screens captured on a live system (A4H) while the
+library drives it, a stale locator healed mid-run (score 97 %), the real SE16
+count, the real drift report. The important bit: healing is never silent. A
+runtime WARNING becomes cumulative telemetry, then
+`scripts/healing_drift_report.py` locates the patch to make in `resources/`
+without changing business tests.
+
+▶️ **[Watch the full demo video](https://github.com/CyrilM29/robotframework-sapfx/blob/main/docs/media/healing-live.mp4)** — a 30-second
+screencast of SAP GUI being driven live (transaction typed, healing, real count
+popup, ALV grid), with the drift report and the applied patch.
+
+## Where this sits — including wdi5
+
+[wdi5](https://github.com/ui5-community/wdi5) is the reference for UI5
+end-to-end testing outside Robot Framework (UI5-community project,
+WebdriverIO-based, actively maintained). This project is **not** a wdi5
+replacement and does not try to be one. The positioning is different: **SAP
+test automation in Robot Framework**, where the SAP GUI desktop client, the
+OData/RFC API channel and Fiori/UI5 share one business vocabulary, one runner
+and **one report**.
+
+- Your stack is JS/WebdriverIO and your scope is a UI5 app → wdi5 is the
+  natural choice.
+- Your stack is Robot Framework, or your scenario spans the desktop client,
+  APIs and Fiori in the same run → that is what this project is for.
+
+Details in [docs/fiori-architecture.md](docs/fiori-architecture.md)
+(§ “Why not Selenium / raw CSS / wdi5”).
+
+## What this fork adds over upstream
+
+The upstream library is a solid base with good keyword coverage (including ALV
+grids). This fork keeps **all** of it and adds the things production SAP automation
+needs — see the full [audit](docs/audit-upstream.md):
+
+- **Real synchronisation** instead of fixed `sleep`s — `Wait Until Busy Done`,
+  `Wait Until Element Present`, `Wait Until Element Value Is`.
+- **Autonomous bootstrap** — `Open Sap Logon` launches the Logon Pad and waits for
+  the scripting engine; `Connect To Session With Retry`; `Close Sap Logon`.
+- **Locale-independent** `Run Transaction` (reads the status-bar message *type*,
+  not English/Dutch/German text) + `Status Message Should Be Success`.
+- **ALV grids by column title** — `Get Cell Value By Column Title`, `Read Grid`
+  (→ list of dicts), `Get Column Id By Title`.
+- **Screen perception** — `Get Screen Signature` (ECC) and `Get Ui5 Page Tree`
+  (Fiori): a read-only text/XML view of the live screen, for locator debugging and
+  AI-agent integration. Both support `mode=diff` (only what changed since the
+  previous perception).
+- **Scripting preflight & telemetry** (ECC) — `Scripting Should Be Fully Enabled`
+  fails early with the exact RZ11 parameter to fix; `Enable Test Tool Mode`,
+  `Get Session Telemetry`.
+- **Locator healing, never silent** — failures suggest the closest ids on screen
+  (scored); `Resolve Element With Healing` (ECC) and `Resolve Ui5 With Fallback`
+  (Fiori: role→xpath→sid→wc chain) repair a stale locator with a logged WARNING,
+  feeding an opt-in telemetry journal (`SAPFX_HEALING_LOG`) that
+  `scripts/healing_drift_report.py` turns into preventive maintenance
+  (stable drifts located in `resources/`, patch proposed, `--apply` executes).
+- **Human locators** (ECC, ported from RoboSAPiens with a stricter policy) —
+  `Find/Fill/Read Field By Label`, `Click Button By Label`: visible label +
+  geometry, grid positions (`N @ Label` / `Label @ N`), scoped anchor
+  (`Anchor >> Rest`, tunable `scope_radius`); ambiguity always reported with
+  candidates, never a silent first match.
+- **Visual assertions** (ECC) — `Screen Should Match Baseline` (perceptual
+  dHash over in-memory screenshots, snapshot semantics): pixel-level coverage
+  for exactly what the Scripting API cannot see (opaque GuiShell lists,
+  record-only charts). Optional `visual` extra (Pillow).
+- **Embedded WebView2 bridge** (ECC) — `Switch To Embedded Browser Page` hands
+  a WebView2 control embedded in a SAP GUI/Business Client window to the
+  Browser library over CDP: both channels in one suite.
+- **Launchpad iframes & Fiori Elements** — `Set Ui5 Frame` for Work Zone/cFLP
+  apps embedded in a (cross-origin) iframe; stable `idSuffix=fe::…` selectors.
+  Multi-version UI5: 1.60 → 2.0 nightly, proven live.
+- **Recorders**, not just spies — desktop (`tools/recorder`: highlight,
+  click-to-capture, hover, `--record` replayable keyword sequences with a
+  **native event engine** — exact buttons/grids/trees via the Scripting API's
+  `Change` events, automatic polling fallback; Tkinter launcher + root
+  `recorder.cmd`) and web (`tools/recorder_web`: snippet **and** a Chrome MV3
+  extension that exports a `*** Test Cases ***` body, incl. value assertions and
+  iframe support). No third-party tracker.
+- **rf-mcp (RobotMCP) integration** (`integrations/robotmcp/`) — `SapEccPlugin` /
+  `SapFioriPlugin` plug into the [rf-mcp](https://github.com/manykarim/robotframework-mcp)
+  server: keyword routing, SAP selector guidance, and live screen perception for
+  AI agents. Validated end-to-end against a live A4H system and a live UI5 page.
+
+## Layout
+
+```text
+src/SapEccLibrary/          # phase 1 — SAP GUI thick client (COM)
+  _vendor/sapgui_base.py    #   upstream, vendored verbatim (class renamed only)
+  keywords/_connection.py   #   bootstrap mixin (Logon Pad, retry, CoInitialize)
+  keywords/_waits.py        #   synchronisation mixin (+ closest-match hints)
+  keywords/_grid.py         #   ALV ergonomics mixin
+  keywords/_perception.py   #   Get Screen Signature (mode=diff) + screenshots
+                            #   + visual assertions (perceptual-hash baselines)
+  keywords/_diagnostics.py  #   scripting preflight + TestToolMode + telemetry
+  keywords/_healing.py      #   Resolve Element With Healing (logged, never silent)
+  keywords/_semantic.py     #   human locators (label + geometry, grids, >> scope)
+  keywords/_embedded_browser.py  # WebView2/CDP bridge to the Browser library
+  SapEccLibrary.py          #   composes them + locale-safe Run Transaction
+src/SapFioriLibrary/        # phase 2 — Fiori / S/4HANA web (Playwright + UI5)
+  _ui5_runtime.py           #   UI5 control-selector model (pure data)
+  _ui5_js.py                #   injected __SAPFX bundle: tree, XPath/role engines, sid
+  regen_recorder.py         #   regenerates the web recorder (snippet + extension)
+  SapFioriLibrary.py        #   resolves UI5 selectors via the Browser page
+                            #   (+ Set Ui5 Frame, Resolve Ui5 With Fallback, idSuffix)
+src/SapApiLibrary/          # API channel: OData v2/v4 + CSRF, optional RFC (stdlib-only)
+src/sapfx_common/           # shared primitives: polling/retry, COM safety,
+                            #   healing scoring + telemetry, perception diff,
+                            #   object tree, semantic engine, visual hash
+resources/                  # business keywords — ecc_keywords + fiori_keywords (mirrored)
+                            # + a4h_demo_data (SFLIGHT/EPM demo-data guards)
+tests/unit/                 # off-SAP/off-browser logic tests (run anywhere)
+tests/robot/                # ecc_smoke + ecc_data_smoke + ecc_exploration (need SAP),
+                            # fiori_smoke (OpenUI5 Demo Kit), fiori_sflight_smoke
+                            # (local cap-sflight), compat smokes (UI5 1.60 legacy,
+                            # UI5 2.0 nightly, cross-origin iframes)
+                            # + recorder smokes (desktop record engine, web record mode)
+                            # + flagship_cross_paradigm (GUI ↔ API ↔ Fiori cross-checks)
+tools/recorder/             # desktop recorder (SAP GUI object tree, GUI launcher,
+                            # native event record engine w/ polling fallback)
+tools/recorder_web/         # web recorder: snippet + Chrome MV3 extension
+integrations/robotmcp/      # rf-mcp plugins: keyword routing + SAP screen perception
+packaging/ + scripts/       # Windows deployment pack sources + repo tooling
+                            # (build_release_pack.py -> dist/sapfx-pack-<v>-win.zip)
+docs/                       # architecture, fiori-architecture, mcp-integration,
+                            # audit-upstream, testing-without-sap, ecc-validation,
+                            # sap-test-data, deployment-pack — all bilingual EN/FR
+```
+
+## Install
+
+```bash
+pip install -r requirements.txt      # robotframework + pywin32 (pinned, Windows) + browser
+rfbrowser init                       # one-time: download Playwright browsers (Fiori side)
+```
+
+SAP-side prerequisites (scripting enabled server/client) are in
+[docs/testing-without-sap.md](docs/testing-without-sap.md), which also explains how
+to get a **free local SAP system** to test against (ABAP Platform Trial in Docker).
+The Fiori side needs no SAP at all — it tests against the public OpenUI5 Demo Kit.
+
+## Quick start
+
+Tests speak business language; SAP element ids stay in the resource layer
+(convention: **no raw ids, no CSS/XPath in test cases**):
+
+```robotframework
+*** Settings ***
+Resource    resources/ecc_keywords.resource
+Suite Setup       Open SAP And Log In
+Suite Teardown    Close SAP
+
+*** Test Cases ***
+Read The Clients Table In SE16
+    Go To Transaction    SE16
+    Display Table Contents    T000
+    ${rows}=    Read Displayed Grid    max_rows=5
+    Log    ${rows}
+
+*** Variables ***
+${SE16_TABLE_FIELD}    wnd[0]/usr/ctxtDATABROWSE-TABLENAME
+${SE16_GRID}           wnd[0]/usr/cntlGRID1/shellcont/shell
+
+*** Keywords ***
+# In a real project these live in resources/, next to ecc_keywords.resource.
+Display Table Contents
+    [Arguments]    ${table}
+    Input Text    ${SE16_TABLE_FIELD}    ${table}
+    Send Vkey     0
+    Send Vkey     8
+    Wait Until Element Present    ${SE16_GRID}
+
+Read Displayed Grid
+    [Arguments]    ${max_rows}=5
+    ${rows}=    Read Grid    ${SE16_GRID}    max_rows=${max_rows}
+    RETURN    ${rows}
+```
+
+Run it (against a system — credentials via variables; `Secret` is the Robot
+Framework 7.4 typed-variable syntax, keeping the password out of logs even at
+TRACE level):
+
+```bash
+robot -v SAP_CONNECTION:"MY SYSTEM" -v SAP_USER:DEVELOPER \
+      -v "SAP_PASSWORD: Secret:secret" tests/robot/ecc_smoke.robot
+robot tests/robot/fiori_smoke.robot   # Fiori — no SAP needed (OpenUI5 Demo Kit)
+```
+
+## Tests
+
+```bash
+python -m pytest tests/unit -q       # logic tests, no SAP required
+```
+
+## License
+
+Apache 2.0. Includes vendored code from robotframework-sapguilibrary and locator
+engines ported from playwright-sap — see [LICENSE](LICENSE) and [NOTICE](NOTICE).