manul-engine 0.0.5__tar.gz

manul_engine-0.0.5/.env.example

@@ -0,0 +1,62 @@
+# ==============================================================================
+# 😼 ManulEngine — Example .env
+# ==============================================================================
+# Copy this file to `.env` (same folder) to override defaults.
+# If `.env` does not exist, ManulEngine uses built-in defaults.
+
+# Ollama model name
+MANUL_MODEL=qwen2.5:0.5b
+
+# Browser visibility mode
+# False = visible browser window (recommended for debugging)
+# True  = headless
+MANUL_HEADLESS=False
+
+# ==============================================================================
+# 🎛️ AI Controls
+# ==============================================================================
+# By default, process environment variables win over values in this file (safer
+# for CI/prod). For local prompt tuning you can make repo `.env` override any
+# already-set environment variables:
+MANUL_DOTENV_OVERRIDE=False
+
+# Confidence threshold for LLM fallback.
+# - If best heuristic score >= threshold → Manul trusts heuristics.
+# - If best heuristic score < threshold  → Manul asks the LLM.
+# Special case: <= 0 disables LLM fallback completely.
+#
+# If you leave it unset, the engine auto-derives it from model size.
+#MANUL_AI_THRESHOLD=500
+
+# When True, ALL element resolution decisions go through the LLM element picker
+# (heuristic short-circuits are bypassed).
+MANUL_AI_ALWAYS=False
+
+# How the LLM should treat heuristic scores when selecting an element:
+# - prior  (default): score is a hint; LLM may override with a clear reason.
+# - strict          : enforce best-score determinism (useful for synthetic/id-strict tests).
+MANUL_AI_POLICY=prior
+
+# ============================================================================== 
+# 💾 Persistent Controls Cache
+# ==============================================================================
+# Save resolved controls per site in a disk cache (repo-root cache/ by default).
+MANUL_CONTROLS_CACHE_ENABLED=True
+
+# Optional custom location for the persistent cache directory.
+# Relative paths are resolved from project root.
+#MANUL_CONTROLS_CACHE_DIR=cache
+
+# ============================================================================== 
+# 🧾 Logging
+# ==============================================================================
+# Collapse whitespace in element names/thoughts and (optionally) truncate.
+# 0 = no truncation.
+MANUL_LOG_NAME_MAXLEN=0
+MANUL_LOG_THOUGHT_MAXLEN=0
+
+# ==============================================================================
+# ⏱️ Timeouts (ms)
+# ==============================================================================
+MANUL_TIMEOUT=5000
+MANUL_NAV_TIMEOUT=30000

manul_engine-0.0.5/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 2026 Oleksii Poliakov
+
+   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.

manul_engine-0.0.5/MANIFEST.in

@@ -0,0 +1,6 @@
+include LICENSE
+include README.md
+include manul_engine_configuration.json
+recursive-include manul_engine *.py
+include manul_engine/py.typed
+recursive-exclude manul_engine/test *

manul_engine-0.0.5/PKG-INFO

@@ -0,0 +1,301 @@
+Metadata-Version: 2.4
+Name: manul-engine
+Version: 0.0.5
+Summary: Resilient neuro-symbolic browser automation framework powered by Playwright and local LLMs (Ollama)
+Author: ManulEngine Contributors
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/alexbeatnik/ManulEngine
+Project-URL: Repository, https://github.com/alexbeatnik/ManulEngine
+Project-URL: Bug Tracker, https://github.com/alexbeatnik/ManulEngine/issues
+Keywords: browser-automation,playwright,llm,ollama,e2e-testing,web-testing,neuro-symbolic,heuristics
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Internet :: WWW/HTTP :: Browsers
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: playwright>=1.40.0
+Provides-Extra: ai
+Requires-Dist: ollama>=0.1.6; extra == "ai"
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: ollama>=0.1.6; extra == "dev"
+Dynamic: license-file
+
+# 😼 ManulEngine — The Mastermind
+
+ManulEngine is a relentless hybrid (neuro-symbolic) framework for browser automation and E2E testing.
+
+Forget brittle CSS/XPath locators that break on every UI update — write tests in plain English.
+Stop paying for expensive cloud APIs — leverage local micro-LLMs via **Ollama**, entirely on your machine.
+
+Manul combines the blazing speed of **Playwright**, powerful JavaScript DOM heuristics, and the reasoning of local neural networks. It is fast, private, and highly resilient to UI changes.
+
+> The Manul goes hunting and never returns without its prey.
+
+---
+
+## ✨ Key Features
+
+### ⚡ Heuristics-First Architecture
+
+95% of the heavy lifting (element finding, assertions, DOM parsing) is handled by ultra-fast JavaScript and Python heuristics. The AI steps in only when genuine ambiguity arises.
+
+When the LLM picker is used, Manul passes the heuristic score as a **prior** (hint) by default — the model can override the ranking only with a clear, disqualifying reason.
+
+### 🛡️ Unbreakable JS Fallbacks
+
+Modern websites love to hide elements behind invisible overlays, custom dropdowns, and zero-pixel traps. Manul uses Playwright with `force=True` plus retries and self-healing; for Shadow DOM elements it falls back to direct JS helpers to keep execution moving.
+
+### 🌑 Shadow DOM Awareness
+
+The DOM snapshotter recursively inspects shadow roots and can interact with elements inside the shadow tree.
+
+### 👻 Smart Anti-Phantom Guard & AI Rejection
+
+Strict protection against LLM hallucinations. If the model is unsure, it returns `{"id": null}`; the engine treats that as a rejection and retries with self-healing.
+
+### 🎛️ Adjustable AI Threshold
+
+Control how aggressively Manul falls back to the local LLM via `manul_engine_configuration.json` (`ai_threshold` key) or the `MANUL_AI_THRESHOLD` environment variable. If not set, Manul auto-calculates it from the model size:
+
+| Model size | Auto threshold |
+|---|---|
+| `< 1b` | `500` |
+| `1b – 4b` | `750` |
+| `5b – 9b` | `1000` |
+| `10b – 19b` | `1500` |
+| `20b+` | `2000` |
+
+Set `MANUL_AI_THRESHOLD=0` to disable the LLM entirely and run fully on deterministic heuristics.
+
+### 🗂️ Persistent Controls Cache
+
+Successful element resolutions are stored per-site and reused on subsequent runs — making repeated test flows dramatically faster.
+
+---
+
+## 🛠️ Installation
+
+```bash
+pip install manul-engine
+playwright install chromium
+```
+
+### Optional: Local LLM (Ollama)
+
+Ollama is only needed for AI element-picker fallback or free-text mission planning.
+
+```bash
+ollama pull qwen2.5:0.5b
+ollama serve
+```
+
+---
+
+## 🚀 Quick Start
+
+### 1. Create a hunt file
+
+`my_tests/hunt_smoke.hunt`
+
+```text
+@context: Demo smoke test
+@blueprint: smoke
+
+1. NAVIGATE to https://demoqa.com/text-box
+2. Fill 'Full Name' field with 'Ghost Manul'
+3. Click the 'Submit' button
+4. VERIFY that 'Ghost Manul' is present.
+5. DONE.
+```
+
+### 2. Run it
+
+```bash
+# Run a specific hunt file
+manul my_tests/hunt_smoke.hunt
+
+# Run all *.hunt files in a folder
+manul my_tests/
+
+# Run headless
+manul my_tests/ --headless
+
+# Run an inline one-liner
+manul "1. NAVIGATE to https://example.com  2. Click the 'More' link  3. DONE."
+```
+
+### 3. Python API
+
+```python
+import asyncio
+from manul_engine import ManulEngine
+
+async def main():
+    manul = ManulEngine(headless=True)
+    await manul.run_mission("""
+        1. NAVIGATE to https://demoqa.com/text-box
+        2. Fill 'Full Name' field with 'Ghost Manul'
+        3. Click the 'Submit' button
+        4. VERIFY that 'Ghost Manul' is present.
+        5. DONE.
+    """)
+
+asyncio.run(main())
+```
+
+---
+
+## 📜 Hunt File Format
+
+Hunt files are plain-text test scenarios with a `.hunt` extension.
+
+### Headers (optional)
+
+```text
+@context: Strategic context passed to the LLM planner
+@blueprint: short-tag
+```
+
+### Comments
+
+Lines starting with `#` are ignored.
+
+### System Keywords
+
+| Keyword | Description |
+|---|---|
+| `NAVIGATE to [URL]` | Load a URL and wait for DOM settlement |
+| `WAIT [seconds]` | Hard sleep |
+| `SCROLL DOWN` | Scroll the main page down one viewport |
+| `EXTRACT [target] into {var}` | Extract text into a memory variable |
+| `VERIFY that [target] is present` | Assert text/element is visible |
+| `VERIFY that [target] is NOT present` | Assert absence |
+| `VERIFY that [target] is DISABLED` | Assert element state |
+| `VERIFY that [target] is checked` | Assert checkbox state |
+| `DONE.` | End the mission |
+
+### Interaction Steps
+
+```text
+# Clicking
+Click the 'Login' button
+DOUBLE CLICK the 'Image'
+
+# Typing
+Fill 'Email' field with 'test@example.com'
+Type 'hello' into the 'Search' field
+
+# Dropdowns
+Select 'Option A' from the 'Language' dropdown
+
+# Checkboxes / Radios
+Check the checkbox for 'Terms'
+Uncheck the checkbox for 'Newsletter'
+Click the radio button for 'Male'
+
+# Hover & Drag
+HOVER over the 'Menu'
+Drag the element "Item" and drop it into "Box"
+
+# Optional steps (non-blocking)
+Click 'Close Ad' if exists
+```
+
+### Variables
+
+```text
+EXTRACT the price of 'Laptop' into {price}
+VERIFY that '{price}' is present.
+```
+
+---
+
+## ⚙️ Configuration
+
+Create `manul_engine_configuration.json` in your project root — all settings are optional:
+
+```json
+{
+  "model": "qwen2.5:0.5b",
+  "headless": false,
+  "timeout": 5000,
+  "nav_timeout": 30000,
+
+  "ai_always": false,
+  "ai_policy": "prior",
+  "ai_threshold": null,
+
+  "controls_cache_enabled": true,
+  "controls_cache_dir": "cache",
+
+  "log_name_maxlen": 0,
+  "log_thought_maxlen": 0
+}
+```
+
+> Set `"model": null` (or omit it) to disable AI entirely and run in **heuristics-only mode**.
+
+Environment variables (`MANUL_*`) always override JSON values — useful for CI/CD:
+
+```bash
+export MANUL_HEADLESS=true
+export MANUL_AI_THRESHOLD=0
+export MANUL_MODEL=qwen2.5:0.5b
+```
+
+| Key | Default | Description |
+|---|---|---|
+| `model` | `null` | Ollama model name. `null` = heuristics-only (no AI) |
+| `headless` | `false` | Hide browser window |
+| `ai_threshold` | auto | Score threshold before LLM fallback. `null` = auto by model size |
+| `ai_always` | `false` | Always use LLM picker, bypass heuristic short-circuits |
+| `ai_policy` | `"prior"` | `"prior"` (LLM may override score) or `"strict"` (enforce max-score) |
+| `controls_cache_enabled` | `true` | Persistent per-site controls cache |
+| `controls_cache_dir` | `"cache"` | Cache directory (relative to CWD or absolute) |
+| `timeout` | `5000` | Default action timeout (ms) |
+| `nav_timeout` | `30000` | Navigation timeout (ms) |
+| `log_name_maxlen` | `0` | Truncate element names in logs (0 = no limit) |
+| `log_thought_maxlen` | `0` | Truncate LLM thoughts in logs (0 = no limit) |
+
+---
+
+## 📋 Available Commands
+
+| Category | Command Syntax |
+|---|---|
+| **Navigation** | `NAVIGATE to [URL]` |
+| **Input** | `Fill [Field] with [Text]`, `Type [Text] into [Field]` |
+| **Click** | `Click [Element]`, `DOUBLE CLICK [Element]` |
+| **Selection** | `Select [Option] from [Dropdown]`, `Check [Checkbox]`, `Uncheck [Checkbox]` |
+| **Mouse Action** | `HOVER over [Element]`, `Drag [Element] and drop it into [Target]` |
+| **Data Extraction** | `EXTRACT [Target] into {variable_name}` |
+| **Verification** | `VERIFY that [Text] is present/absent`, `VERIFY that [Element] is checked/disabled` |
+| **Flow Control** | `WAIT [seconds]`, `SCROLL DOWN` |
+| **Finish** | `DONE.` |
+
+> Append `if exists` or `optional` to any step (outside quoted text) to make it non-blocking,
+> e.g. `Click 'Close Ad' if exists`
+
+---
+
+## 🐾 Battle-Tested
+
+ManulEngine is verified against **1200+ synthetic DOM tests** covering:
+
+- Shadow DOM, invisible overlays, zero-pixel honeypots
+- Custom dropdowns, drag-and-drop, hover menus
+- Legacy HTML (tables, fieldsets, unlabelled inputs)
+- AI rejection & self-healing loops
+- Persistent controls cache hit/miss cycles
+
+---
+
+**Version:** 0.0.5 · **Status:** Hunting...