sto-warp 0.1.0.dev0__tar.gz

sto_warp-0.1.0.dev0/.gitignore

@@ -0,0 +1,56 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+.python/
+
+# Build/dist
+build/
+dist/
+
+# IDE
+.idea/
+.vscode/
+
+# Claude Code local config
+.claude/
+
+# Editor / OS
+*.bak
+*.orig
+.DS_Store
+
+# Runtime
+*.log
+.env
+.config/
+*.ini
+..debug/
+
+# WARP runtime (downloaded at first run; user-local)
+warp/models/
+# warp/data/baseline/ IS committed (offline fallback snapshot).
+# Everything else under warp/data/ is local/runtime.
+warp/data/icons/
+warp/data/item_db.json
+warp/data/cache/
+warp/knowledge/knowledge_cache.json
+warp/knowledge/install_id.txt
+warp/knowledge/rate_limit.json
+warp/hub_token.txt
+warp/training_data/
+
+# Local-only developer diagnostics
+tests/diag_*.py
+tests/_diag_out/
+
+# Maintainer review tools — superseded by the democratic merger cron,
+# kept locally for emergency one-shot use.
+warp/tools/review_staging.py
+warp/tools/conflict_reviewer.py
+staging_review.json
+conflict_decisions.json
+
+# Backup directories from upstream migration
+*_backup_*/

sto_warp-0.1.0.dev0/CHANGELOG.md

@@ -0,0 +1,48 @@
+# Changelog
+
+All notable changes to **sto-warp** will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+### Added
+- Initial repository scaffold split out from `sets-warp`.
+- `warp.debug` standalone logger replaces `src.setsdebug`; split into
+  detection / system channels (`warp_detection.log` / `warp_system.log`).
+- Foundation modules ported from `sets-warp/warp/`:
+  - `warp.recognition` — `boff_keys`, `boff_marker`, `eq_geometry`,
+    `ground_eq_geometry`, `icon_matcher`, `layout_detector`,
+    `screen_classifier`, `text_extractor`, `trait_grid`.
+  - `warp.trainer` — `ocr_diag`, `screen_type_trainer`.
+  - `warp.knowledge` — `sync_client`.
+- Standalone GUI (`sto-warp` / `sto-warp gui`) — `warp.gui.warp_window.WarpWindow`
+  replaces the SETS-coupled `warp_dialog.py`:
+  - **Open Screenshot…** (single-file picker) and **Open Folder…** routed
+    through custom split-pane pickers; last-used dirs persisted.
+  - **Force build type** toggle: off → AUTO mode (per-image classification);
+    on → combo value forced on every image. State persisted via QSettings.
+  - **Results** tab: tree grouped by slot, ship banner with name/type/tier.
+  - **Preview** tab: bbox overlay coloured per slot family (weapons red,
+    BOFF orange, traits green, spec magenta, consoles violet, EQ blue,
+    ground EQ cyan).
+  - **Export to SETS JSON…**: SETS v3.0.0-compatible build file.
+- AUTO build-type mode + 3-factor cross-image merge in `WarpImporter`
+  (0.3 · geometry + 0.3 · sibling + 0.4 · recog) replaces per-slot max-conf
+  merging across same-typed screenshots.
+- Launcher (`warp.gui.launcher.LauncherWindow`) hosts WARP, WARP CORE,
+  Detection logs and System logs as tabs; `🔄 Refresh` button in the status
+  bar manually re-runs the community sync.
+- Detection logs view: terminal-like auto-tail with preserved horizontal
+  scroll, fresh recognition runs wipe the live view; Open-folder button
+  opens the log directory.
+- Full `docs/` tree carried over from `sets-warp` (planning files pruned).
+
+### Pending
+- Cargo data loader fetching from `STOCD/SETS-Data` (strategy iii), cache
+  under `~/.config/warp/cache/`.
+- `pyproject.toml` for pipx distribution; `sto-warp` console entry point.
+- Standalone replacements for the WARP CORE trainer UI files that still
+  depend on the SETS Qt scaffolding.
+- Native packaging recipes (AUR, .deb, .rpm, Windows MSI/EXE).

sto_warp-0.1.0.dev0/INSTALLATION.md

@@ -0,0 +1,71 @@
+# Installation Guide
+
+**STO-WARP** is distributed as a standalone Python package. Because it relies on heavy machine learning libraries (like PyTorch) and a GUI framework (PySide6), we highly recommend installing it in an isolated environment using **`pipx`**.
+
+To make this as easy as possible, we provide universal installation scripts for both Linux/macOS and Windows.
+
+---
+
+## 🚀 The Easy Way (One-Command Install)
+
+### Linux & macOS
+Open your terminal and run the following command:
+
+```bash
+curl -sSL https://raw.githubusercontent.com/raman78/sto-warp/main/install.sh | bash
+```
+
+**What this does:**
+1. Verifies you have Python installed.
+2. Checks for `pipx`. If missing, it installs `pipx` via your system's package manager (`apt`, `dnf`, `pacman`, or `brew`).
+3. Installs `sto-warp` in an isolated environment.
+4. Makes the `sto-warp` command globally available.
+
+### Windows
+Open **PowerShell** and run the following command:
+
+```powershell
+Invoke-WebRequest -Uri "https://raw.githubusercontent.com/raman78/sto-warp/main/install.ps1" -OutFile "install.ps1"; .\install.ps1; Remove-Item "install.ps1"
+```
+
+**What this does:**
+1. Checks if Python is installed. If not, installs it via Windows Package Manager (`winget`).
+2. Checks if `pipx` is installed. If not, installs it.
+3. Installs `sto-warp` globally so you can launch it from anywhere.
+
+---
+
+## 🛠️ The Manual Way (Using pipx)
+
+If you prefer to handle the installation yourself, ensure you have Python 3.14+ installed on your system.
+
+1. **Install pipx**
+   Follow the [official pipx installation instructions](https://pipx.pypa.io/stable/installation/) for your operating system.
+
+2. **Install sto-warp**
+   ```bash
+   pipx install sto-warp
+   ```
+
+3. **Verify the installation**
+   ```bash
+   sto-warp check
+   ```
+
+## 🔄 Updating STO-WARP
+
+Regardless of how you installed it, since `sto-warp` is managed by `pipx`, you can always update to the latest version by running:
+
+```bash
+pipx upgrade sto-warp
+```
+
+## 🗑️ Uninstalling
+
+To completely remove `sto-warp` and all its dependencies from your system:
+
+```bash
+pipx uninstall sto-warp
+```
+
+*(Note: Downloaded data and machine learning models cached in `~/.config/warp/` are not removed automatically. You can delete that folder manually if you wish to clear all data).*