Compare commits
7 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 9ae2e22b44 | |||
| 89ebb6c61e | |||
| c8f7d66349 | |||
| 6215181d23 | |||
| 09cbc57b8c | |||
| f3021c4ddb | |||
| ca4bc4c64f |
@@ -28,9 +28,7 @@ jobs:
|
||||
python -m build
|
||||
|
||||
- name: Build self-extracting installer (.run)
|
||||
run: |
|
||||
(apt-get update && apt-get install -y makeself && sh packaging/make-run.sh) \
|
||||
|| echo "makeself unavailable — skipping .run"
|
||||
run: python packaging/make_run.py
|
||||
|
||||
- name: Read version
|
||||
id: ver
|
||||
@@ -38,6 +36,30 @@ jobs:
|
||||
V=$(python -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
|
||||
echo "version=$V" >> "$GITHUB_OUTPUT"
|
||||
|
||||
- name: Build release notes
|
||||
run: |
|
||||
python - <<'PY'
|
||||
import json
|
||||
version = "${{ steps.ver.outputs.version }}"
|
||||
tag = f"v{version}"
|
||||
out, capturing = [], False
|
||||
try:
|
||||
for line in open("CHANGELOG.md", encoding="utf-8").read().splitlines():
|
||||
if line.startswith("## "):
|
||||
if capturing:
|
||||
break
|
||||
capturing = line.startswith(f"## [{version}]")
|
||||
continue
|
||||
if capturing:
|
||||
out.append(line)
|
||||
except OSError:
|
||||
pass
|
||||
body = "\n".join(out).strip() or f"Release {tag}."
|
||||
payload = {"tag_name": tag, "target_commitish": "${{ github.sha }}", "name": tag, "body": body}
|
||||
open("/tmp/release.json", "w", encoding="utf-8").write(json.dumps(payload))
|
||||
print(f"release notes: {len(body)} chars")
|
||||
PY
|
||||
|
||||
- name: Publish Gitea release
|
||||
env:
|
||||
TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
@@ -57,7 +79,7 @@ jobs:
|
||||
rid=$(curl -sS -X POST \
|
||||
-H "Authorization: token ${TOKEN}" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d "{\"tag_name\":\"${TAG}\",\"target_commitish\":\"${{ github.sha }}\",\"name\":\"${TAG}\",\"body\":\"Automated release for ${TAG}. See CHANGELOG.md.\"}" \
|
||||
-d @/tmp/release.json \
|
||||
"${API}/releases" | python -c "import sys, json; print(json.load(sys.stdin)['id'])")
|
||||
|
||||
for f in dist/*; do
|
||||
|
||||
@@ -5,6 +5,65 @@ All notable changes to RigDoctor are recorded here. Format follows
|
||||
(`MAJOR.MINOR.PATCH`, pre-1.0). `__version__` and `pyproject.toml` must match the git
|
||||
release tag (so the auto-updater, D18, can compare versions).
|
||||
|
||||
## [0.3.1] - 2026-05-21
|
||||
### Fixed
|
||||
- Changelog/release notes now **render Markdown** instead of showing raw `#`/`**` markup —
|
||||
the in-app changelog uses `QTextEdit.setMarkdown()` and the update prompt renders notes as
|
||||
rich text (closes #1).
|
||||
|
||||
## [0.3.0] - 2026-05-21
|
||||
### Added
|
||||
- **System inventory (M5)**: CPU, GPU (model/driver/VBIOS/VRAM/PCIe), motherboard/BIOS, RAM
|
||||
(total + modules), storage, kernel, and display server. CLI `rigdoctor inventory`
|
||||
(`--json` / `--markdown` / `--output`) and a GUI **Inventory** tab with Copy-as-Markdown,
|
||||
Save, and "Run with admin" (for `dmidecode` board/BIOS/RAM details). Fills the last GUI tab.
|
||||
|
||||
## [0.2.0] - 2026-05-21
|
||||
### Added
|
||||
- **"Check for updates" button** in the sidebar — force an immediate version check instead of
|
||||
waiting for the 30-minute poll.
|
||||
|
||||
## [0.1.1] - 2026-05-21
|
||||
### Fixed
|
||||
- Dialogs (the update prompt and changelog) were light-on-light and unreadable — they now use
|
||||
the dark theme with readable text.
|
||||
|
||||
## [0.1.0] - 2026-05-21
|
||||
_First milestone release — a complete, installable, self-updating RigDoctor: live monitoring,
|
||||
crash capture + health report, desktop GUI, user-local install/uninstall, and updates._
|
||||
### Added
|
||||
- **In-app uninstaller**: "Uninstall RigDoctor" button on the Setup page (and
|
||||
`rigdoctor uninstall [--purge]`) — removes the venv, launchers, and desktop entry, with an
|
||||
option to also wipe settings/token/logs. Runs detached so it can delete its own venv.
|
||||
- **In-app changelog**: a "Changelog" link in the sidebar opens the release history (tags +
|
||||
notes) fetched from the update server.
|
||||
|
||||
## [0.0.10] - 2026-05-21
|
||||
### Added
|
||||
- **"Restart now" button** after a successful in-app update — relaunches RigDoctor for you
|
||||
instead of asking you to restart manually.
|
||||
- **Real release notes**: CI now sets each Gitea release's body from the matching CHANGELOG
|
||||
section (instead of "Automated release for…"), and the updater shows **"What's new"** — a
|
||||
notes dialog before applying (GUI) and in `rigdoctor update` (CLI).
|
||||
### Changed
|
||||
- Setup page / `rigdoctor install`: dropped internal module references (M4, M5, …) from the
|
||||
component descriptions — end users don't need them.
|
||||
- Adopting **Conventional Commits** + **git-cliff** (`cliff.toml`, `packaging/changelog.sh`)
|
||||
to generate CHANGELOG entries from commit history going forward (D20).
|
||||
### Fixed
|
||||
- The self-extracting **`.run` installer** is now built **without makeself** (a pure-Python
|
||||
self-extractor, `packaging/make_run.py`), so it reliably attaches to every release — it was
|
||||
silently skipped before because the CI runner couldn't install makeself.
|
||||
|
||||
## [0.0.8] - 2026-05-21
|
||||
### Added
|
||||
- **Periodic update checks**: the GUI now re-checks for new releases while running (every
|
||||
`update_check_minutes`, default 30; 0 disables), so a newly published version is detected
|
||||
without restarting. After applying an update, re-checks stop until restart.
|
||||
- **"Run with admin" on the Health page**: runs all checks (including root-only SMART) via
|
||||
`pkexec rigdoctor report --json`, so the full report — not just "SMART needs root" — is
|
||||
available from the UI.
|
||||
|
||||
## [0.0.7] - 2026-05-21
|
||||
### Added
|
||||
- **User-local installer** `install.sh` (no root): creates a private venv, links
|
||||
|
||||
+42
@@ -0,0 +1,42 @@
|
||||
# git-cliff configuration — generate CHANGELOG.md from Conventional Commits (D20).
|
||||
# Run via packaging/changelog.sh.
|
||||
|
||||
[changelog]
|
||||
header = """
|
||||
# Changelog
|
||||
|
||||
All notable changes to RigDoctor are recorded here. Format follows
|
||||
[Keep a Changelog](https://keepachangelog.com/); versioning is SemVer-style
|
||||
(`MAJOR.MINOR.PATCH`, pre-1.0). `__version__` and `pyproject.toml` must match the git
|
||||
release tag (so the auto-updater, D18, can compare versions).
|
||||
"""
|
||||
body = """
|
||||
{% for group, commits in commits | group_by(attribute="group") %}
|
||||
## {{ group | upper_first }}
|
||||
{% for commit in commits %}\
|
||||
- {{ commit.message | upper_first }}\
|
||||
{% endfor %}
|
||||
{% endfor %}
|
||||
"""
|
||||
trim = true
|
||||
|
||||
[git]
|
||||
conventional_commits = true
|
||||
filter_unconventional = false
|
||||
commit_parsers = [
|
||||
{ message = "^feat", group = "Added" },
|
||||
{ message = "^fix", group = "Fixed" },
|
||||
{ message = "^docs", group = "Documentation" },
|
||||
{ message = "^perf", group = "Performance" },
|
||||
{ message = "^refactor", group = "Changed" },
|
||||
{ message = "^chore\\(release\\)", skip = true },
|
||||
{ message = "^chore|^build|^ci|^style|^test", group = "Internal" },
|
||||
{ message = ".*", group = "Other" },
|
||||
]
|
||||
tag_pattern = "v[0-9]*"
|
||||
sort_commits = "oldest"
|
||||
|
||||
[bump]
|
||||
# Pre-1.0 rules (D21): feat -> minor, fix -> patch, breaking -> minor (not major).
|
||||
features_always_bump_minor = true
|
||||
breaking_always_bump_major = false
|
||||
+31
-2
@@ -191,12 +191,41 @@ desirable — access control is delegated to Gitea.
|
||||
PATCH for ordinary changes, MINOR for larger milestones). `__version__`
|
||||
(`rigdoctor/__init__.py`) and `pyproject.toml` are the single source of truth and **must match
|
||||
the git release tag** so the auto-updater (D18) can compare versions. Every change updates
|
||||
`CHANGELOG.md` (Keep a Changelog style). *Note:* an early placeholder `0.1.0` was corrected to
|
||||
`CHANGELOG.md` — now generated from **Conventional Commits** via git-cliff (see D20).
|
||||
*Milestone policy (pre-1.0):* **0.0.x** = early development; **0.1.0** = first complete,
|
||||
installable, self-updating release (reached 2026-05-21); **0.x.0** = each later milestone
|
||||
(AMD/Intel, unattended logger auto-start, session sharing…); **1.0.0** = broadly stable
|
||||
(multi-vendor/distro, no major caveats). PATCH (`0.x.PATCH`) for fixes/small changes. *Note:* an early placeholder `0.1.0` was corrected to
|
||||
follow the released **0.0.x** line — first release was **V0.0.1**; current is **0.0.2**.
|
||||
|
||||
### D20 — Automated changelog & release notes — *DECIDED 2026-05-21*
|
||||
**Release notes are generated from our changes, surfaced in the auto-updater.**
|
||||
- *Release body:* CI sets each Gitea release's `body` from the matching `CHANGELOG.md`
|
||||
section (was a hardcoded "Automated release for…"). The updater fetches the release `body`
|
||||
and shows **"What's new"** — a dialog before applying (GUI) and in `rigdoctor update` (CLI).
|
||||
- *Generation:* adopt **Conventional Commits** (`feat:`/`fix:`/`docs:`/`chore:` …) and
|
||||
**git-cliff** (`cliff.toml`, `packaging/changelog.sh`) to generate `CHANGELOG.md` from
|
||||
commit history. Refines D19's "hand-write CHANGELOG" to "generate it from conventional
|
||||
commits"; `__version__`/`pyproject.toml`/tag still the source of truth for the version.
|
||||
- *CI does not auto-commit the changelog* (avoids push loops) — it's regenerated by the dev
|
||||
via the script when cutting a version; CI only reads the section for the release body.
|
||||
|
||||
### D21 — Versioning rules & automation — *DECIDED 2026-05-21*
|
||||
The next version is **determined by the Conventional Commit types** since the last release
|
||||
(D20), so it can be auto-computed instead of guessed:
|
||||
- `fix:` / `perf:` → bump **PATCH**.
|
||||
- `feat:` → bump **MINOR** (pre-1.0: `0.MINOR.0`).
|
||||
- breaking (`feat!:` / `BREAKING CHANGE:`) → pre-1.0: bump **MINOR** (not major); post-1.0: MAJOR.
|
||||
- `docs:` / `chore:` / `refactor:` / `ci:` / `test:` / `style:` alone → **PATCH** (no feature release).
|
||||
- Milestone overrides by hand are allowed (e.g., jumping to `1.0.0`); see the milestone policy in D19.
|
||||
|
||||
*Automation:* `git-cliff --bumped-version` computes the next version from history;
|
||||
`packaging/bump.sh` writes it into `__init__.py` + `pyproject.toml`. Rules live in
|
||||
`cliff.toml [bump]` (pre-1.0: `breaking_always_bump_major = false`).
|
||||
|
||||
## Open
|
||||
|
||||
None currently — all tracked decisions (D1–D19) are resolved. New questions will be added
|
||||
None currently — all tracked decisions (D1–D21) are resolved. New questions will be added
|
||||
here as they arise. Remaining detail to flesh out during build: the tray's supporting-action
|
||||
set (D13), per-module apt package names, M12's tunnel/token specifics, and M13's
|
||||
update mechanism (APT repo vs. self-installed `.deb`).
|
||||
|
||||
+3
-2
@@ -13,7 +13,7 @@ Status: ⬜ not started · 🟦 designing · 🟨 in progress · ✅ done
|
||||
| M4 | Health report (log scan) | Essential | none (opt: smartmontools) | all (NVIDIA first) | P0 | 🟨 |
|
||||
| M2 | Live monitor (TUI) | Monitoring | none (stdlib curses) | all | P1 | ⬜ |
|
||||
| M8 | Alerting | Monitoring | libnotify (opt) | all | P2 | ⬜ |
|
||||
| M5 | System inventory | Diagnostics | none (opt: lm-sensors, dmidecode) | all | P1 | ⬜ |
|
||||
| M5 | System inventory | Diagnostics | none (opt: lm-sensors, dmidecode) | all | P1 | 🟨 |
|
||||
| M6 | Gaming env checks | Diagnostics | none | all | P2 | ⬜ |
|
||||
| M10 | Desktop GUI | Desktop UI | **python3-pyside6** | all | P2 | 🟨 |
|
||||
| M11 | Tray / menu-bar applet | Desktop UI | **python3-pyside6** (+ AppIndicator on GNOME) | all | P2 | ⬜ |
|
||||
@@ -59,7 +59,8 @@ Status: ⬜ not started · 🟦 designing · 🟨 in progress · ✅ done
|
||||
and dependency install via pkexec/sudo — `rigdoctor install [--check] [-y]` + GUI Setup tab.
|
||||
The **user-local app install** is `install.sh` (private venv + `~/.local/bin` launchers +
|
||||
desktop entry, no root; handles the `python3-venv` prerequisite) plus a self-extracting
|
||||
**`.run`** (makeself, built by CI). *Pending:* config/module selection + `systemd --user`
|
||||
**`.run`** (pure-Python self-extractor, `packaging/make_run.py`, built by CI). *Pending:*
|
||||
config/module selection + `systemd --user`
|
||||
service enable.
|
||||
- **M12 Session sharing / remote assist** (D16) — let a helper inspect a user's machine, in
|
||||
an escalating ladder: (1) **diagnostic bundle export** (inventory + recent log + report,
|
||||
|
||||
Executable
+25
@@ -0,0 +1,25 @@
|
||||
#!/usr/bin/env sh
|
||||
# Auto-set the next version from Conventional Commits (git-cliff), per D21.
|
||||
# Run after committing your feat:/fix: changes; it updates __init__.py + pyproject.toml.
|
||||
# Then update CHANGELOG.md, commit as `chore(release): vX.Y.Z`, and push (CI tags + releases).
|
||||
set -eu
|
||||
|
||||
ROOT=$(CDPATH= cd -- "$(dirname -- "$0")/.." && pwd)
|
||||
cd "$ROOT"
|
||||
|
||||
command -v git-cliff >/dev/null 2>&1 || { echo "git-cliff not found. Install: pip install git-cliff"; exit 1; }
|
||||
|
||||
NEXT=$(git-cliff --bumped-version | sed 's/^v//')
|
||||
[ -n "$NEXT" ] || { echo "Could not compute the next version."; exit 1; }
|
||||
|
||||
python3 - "$NEXT" <<'PY'
|
||||
import pathlib, re, sys
|
||||
version = sys.argv[1]
|
||||
init = pathlib.Path("src/rigdoctor/__init__.py")
|
||||
init.write_text(re.sub(r'__version__ = "[^"]+"', f'__version__ = "{version}"', init.read_text()))
|
||||
proj = pathlib.Path("pyproject.toml")
|
||||
proj.write_text(re.sub(r'(?m)^version = "[^"]+"', f'version = "{version}"', proj.read_text(), count=1))
|
||||
PY
|
||||
|
||||
echo "Set version to $NEXT."
|
||||
echo "Next: add a '## [$NEXT]' CHANGELOG section, then commit as 'chore(release): v$NEXT'."
|
||||
Executable
+20
@@ -0,0 +1,20 @@
|
||||
#!/usr/bin/env sh
|
||||
# Regenerate CHANGELOG.md from Conventional Commits using git-cliff (D20).
|
||||
# Install once: pip install git-cliff (ships prebuilt binaries)
|
||||
# Usage: packaging/changelog.sh [--tag vX.Y.Z]
|
||||
set -eu
|
||||
|
||||
ROOT=$(CDPATH= cd -- "$(dirname -- "$0")/.." && pwd)
|
||||
cd "$ROOT"
|
||||
|
||||
command -v git-cliff >/dev/null 2>&1 || {
|
||||
echo "git-cliff not found. Install it: pip install git-cliff"
|
||||
exit 1
|
||||
}
|
||||
|
||||
if [ "${1:-}" = "--tag" ] && [ -n "${2:-}" ]; then
|
||||
git-cliff --tag "$2" -o CHANGELOG.md
|
||||
else
|
||||
git-cliff -o CHANGELOG.md
|
||||
fi
|
||||
echo "Wrote CHANGELOG.md"
|
||||
+2
-32
@@ -1,33 +1,3 @@
|
||||
#!/usr/bin/env sh
|
||||
# Build a self-extracting .run installer: bundles the wheel + install.sh so a user
|
||||
# can download one file, run it, and get a no-root user-local install.
|
||||
#
|
||||
# Requires `makeself` (apt install makeself). Run from the repo root.
|
||||
set -eu
|
||||
|
||||
ROOT=$(CDPATH= cd -- "$(dirname -- "$0")/.." && pwd)
|
||||
cd "$ROOT"
|
||||
|
||||
command -v makeself >/dev/null 2>&1 || {
|
||||
echo "makeself not found. Install it: sudo apt install makeself"
|
||||
exit 1
|
||||
}
|
||||
|
||||
VERSION=$(python3 -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
|
||||
mkdir -p dist
|
||||
|
||||
# Build the wheel if it isn't already in dist/.
|
||||
if ! ls dist/rigdoctor-"$VERSION"-py3-none-any.whl >/dev/null 2>&1; then
|
||||
python3 -m build --wheel
|
||||
fi
|
||||
|
||||
STAGE=$(mktemp -d)
|
||||
cp dist/rigdoctor-"$VERSION"-py3-none-any.whl "$STAGE"/
|
||||
cp install.sh "$STAGE"/install.sh
|
||||
chmod +x "$STAGE/install.sh"
|
||||
|
||||
OUT="dist/rigdoctor-$VERSION-installer.run"
|
||||
makeself --notemp-suffix "$STAGE" "$OUT" "RigDoctor $VERSION installer" ./install.sh
|
||||
rm -rf "$STAGE"
|
||||
echo "Built $OUT"
|
||||
echo "Run it with: chmod +x $OUT && ./$OUT"
|
||||
# Build the self-extracting .run installer (delegates to make_run.py — no makeself).
|
||||
exec python3 "$(CDPATH= cd -- "$(dirname -- "$0")" && pwd)/make_run.py" "$@"
|
||||
|
||||
@@ -0,0 +1,62 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Build a dependency-free self-extracting .run installer (no makeself).
|
||||
|
||||
Produces dist/rigdoctor-<version>-installer.run: a POSIX shell stub with an appended
|
||||
tar.gz of the wheel + install.sh. Running it extracts to a temp dir and runs install.sh.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import io
|
||||
import os
|
||||
import subprocess
|
||||
import sys
|
||||
import tarfile
|
||||
import tomllib
|
||||
from pathlib import Path
|
||||
|
||||
ROOT = Path(__file__).resolve().parent.parent
|
||||
MARKER = "__RIGDOCTOR_ARCHIVE__"
|
||||
|
||||
STUB = f"""#!/bin/sh
|
||||
# RigDoctor self-extracting installer. Extracts the embedded archive and runs install.sh.
|
||||
set -eu
|
||||
SKIP=$(awk '/^{MARKER}$/ {{ print NR + 1; exit 0 }}' "$0")
|
||||
TMP=$(mktemp -d)
|
||||
tail -n +"$SKIP" "$0" | tar -xz -C "$TMP"
|
||||
sh "$TMP/install.sh" "$@"
|
||||
RET=$?
|
||||
rm -rf "$TMP"
|
||||
exit $RET
|
||||
{MARKER}
|
||||
"""
|
||||
|
||||
|
||||
def main() -> int:
|
||||
version = tomllib.loads((ROOT / "pyproject.toml").read_text())["project"]["version"]
|
||||
dist = ROOT / "dist"
|
||||
dist.mkdir(exist_ok=True)
|
||||
|
||||
wheel = dist / f"rigdoctor-{version}-py3-none-any.whl"
|
||||
if not wheel.exists():
|
||||
subprocess.run([sys.executable, "-m", "build", "--wheel"], cwd=ROOT, check=True)
|
||||
if not wheel.exists():
|
||||
print(f"wheel not found: {wheel}", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
buf = io.BytesIO()
|
||||
with tarfile.open(fileobj=buf, mode="w:gz") as tar:
|
||||
tar.add(wheel, arcname=wheel.name)
|
||||
tar.add(ROOT / "install.sh", arcname="install.sh")
|
||||
|
||||
out = dist / f"rigdoctor-{version}-installer.run"
|
||||
with open(out, "wb") as f:
|
||||
f.write(STUB.encode())
|
||||
f.write(buf.getvalue())
|
||||
os.chmod(out, 0o755)
|
||||
print(f"Built {out}")
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
raise SystemExit(main())
|
||||
+1
-1
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
||||
|
||||
[project]
|
||||
name = "rigdoctor"
|
||||
version = "0.0.7"
|
||||
version = "0.3.1"
|
||||
description = "Modular hardware monitoring & crash diagnostics for Linux gamers."
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.11"
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
"""RigDoctor — modular hardware monitoring & crash diagnostics for Linux gamers."""
|
||||
|
||||
__version__ = "0.0.7"
|
||||
__version__ = "0.3.1"
|
||||
|
||||
+50
-2
@@ -228,7 +228,7 @@ def cmd_login(args) -> int:
|
||||
print("No token provided.")
|
||||
return 1
|
||||
config.save_token(token)
|
||||
state, tag = updates.update_state()
|
||||
state, tag, _notes = updates.update_state()
|
||||
if state == updates.AUTH:
|
||||
print("Token saved, but the server rejected it (check scope/permissions).")
|
||||
return 1
|
||||
@@ -248,7 +248,7 @@ def cmd_logout(args) -> int:
|
||||
def cmd_update(args) -> int:
|
||||
from .core import updates
|
||||
|
||||
state, tag = updates.update_state()
|
||||
state, tag, notes = updates.update_state()
|
||||
if state == updates.NO_TOKEN:
|
||||
print("No update token. Run `rigdoctor login` after creating one at:")
|
||||
print(f" {updates.TOKEN_PAGE}")
|
||||
@@ -264,6 +264,8 @@ def cmd_update(args) -> int:
|
||||
return 0
|
||||
# AVAILABLE
|
||||
print(f"Update available: {tag} (current v{__version__}).")
|
||||
if notes:
|
||||
print("\nWhat's new:\n" + "\n".join(" " + ln for ln in notes.splitlines()) + "\n")
|
||||
if args.check:
|
||||
return 0
|
||||
print(f"Installing {tag}…")
|
||||
@@ -276,6 +278,41 @@ def cmd_update(args) -> int:
|
||||
return rc
|
||||
|
||||
|
||||
def cmd_uninstall(args) -> int:
|
||||
from .core import uninstall as uninstaller
|
||||
|
||||
scope = "everything (app + settings, token, and logs)" if args.purge else "the app (settings/logs kept)"
|
||||
if not args.yes:
|
||||
try:
|
||||
reply = input(f"Uninstall RigDoctor — remove {scope}? [y/N] ").strip().lower()
|
||||
except EOFError:
|
||||
reply = "n"
|
||||
if reply not in ("y", "yes"):
|
||||
print("Aborted.")
|
||||
return 1
|
||||
uninstaller.uninstall(purge=args.purge)
|
||||
print("Uninstalling… RigDoctor will be removed momentarily.")
|
||||
return 0
|
||||
|
||||
|
||||
def cmd_inventory(args) -> int:
|
||||
from .core import inventory
|
||||
|
||||
sections = inventory.collect()
|
||||
if args.json:
|
||||
text = inventory.render_json(sections)
|
||||
elif args.markdown:
|
||||
text = inventory.render_markdown(sections)
|
||||
else:
|
||||
text = inventory.render_text(sections)
|
||||
if args.output:
|
||||
Path(args.output).write_text(text)
|
||||
print(f"Wrote {args.output}")
|
||||
else:
|
||||
print(text)
|
||||
return 0
|
||||
|
||||
|
||||
def cmd_report(args) -> int:
|
||||
from dataclasses import asdict
|
||||
|
||||
@@ -323,6 +360,11 @@ def build_parser() -> argparse.ArgumentParser:
|
||||
upd.add_argument("--check", action="store_true", help="only report, don't apply")
|
||||
upd.set_defaults(func=cmd_update)
|
||||
|
||||
unin = sub.add_parser("uninstall", help="remove the user-local install")
|
||||
unin.add_argument("--purge", action="store_true", help="also remove settings, token, and logs")
|
||||
unin.add_argument("-y", "--yes", action="store_true", help="don't ask for confirmation")
|
||||
unin.set_defaults(func=cmd_uninstall)
|
||||
|
||||
rec = sub.add_parser("record", help="crash-capture logger (M3)")
|
||||
rec_sub = rec.add_subparsers(dest="record_cmd", required=True)
|
||||
|
||||
@@ -347,6 +389,12 @@ def build_parser() -> argparse.ArgumentParser:
|
||||
rep = sub.add_parser("report", help="health report (M4): scan logs/SMART/driver for issues")
|
||||
rep.add_argument("--json", action="store_true", help="output JSON instead of text")
|
||||
rep.set_defaults(func=cmd_report)
|
||||
|
||||
inv = sub.add_parser("inventory", help="system inventory (M5): export hardware/OS details")
|
||||
inv.add_argument("--json", action="store_true", help="output JSON")
|
||||
inv.add_argument("--markdown", action="store_true", help="output Markdown (for forum/bug reports)")
|
||||
inv.add_argument("-o", "--output", default=None, help="write to a file instead of stdout")
|
||||
inv.set_defaults(func=cmd_inventory)
|
||||
return p
|
||||
|
||||
|
||||
|
||||
@@ -137,6 +137,7 @@ DEFAULTS: dict = {
|
||||
"interval": 1.0, # sampling interval in seconds (default ≤1 Hz — NFR)
|
||||
"log_max_bytes": 20_000_000, # rotate a log segment past this size
|
||||
"log_backups": 10, # keep this many rotated segments (bounds disk use)
|
||||
"update_check_minutes": 30, # re-check for updates this often while running (0 = off)
|
||||
}
|
||||
|
||||
|
||||
|
||||
@@ -23,7 +23,7 @@ class Component:
|
||||
COMPONENTS: tuple[Component, ...] = (
|
||||
Component(
|
||||
"smartmontools", "SMART disk health", "Diagnostics",
|
||||
"Disk health (SMART) in the health report (M4)", ("smartmontools",), "smartctl",
|
||||
"Disk health (SMART) in the health report", ("smartmontools",), "smartctl",
|
||||
),
|
||||
Component(
|
||||
"lm-sensors", "lm-sensors", "Diagnostics",
|
||||
@@ -31,7 +31,7 @@ COMPONENTS: tuple[Component, ...] = (
|
||||
),
|
||||
Component(
|
||||
"dmidecode", "dmidecode", "Diagnostics",
|
||||
"Motherboard / BIOS / RAM details for system inventory (M5)", ("dmidecode",), "dmidecode",
|
||||
"Motherboard / BIOS / RAM details for system inventory", ("dmidecode",), "dmidecode",
|
||||
),
|
||||
Component(
|
||||
"pciutils", "pciutils", "Diagnostics",
|
||||
@@ -39,10 +39,10 @@ COMPONENTS: tuple[Component, ...] = (
|
||||
),
|
||||
Component(
|
||||
"libnotify", "Desktop notifications", "Monitoring",
|
||||
"Desktop alert notifications (M8)", ("libnotify-bin",), "notify-send",
|
||||
"Desktop alert notifications", ("libnotify-bin",), "notify-send",
|
||||
),
|
||||
Component(
|
||||
"libsecret", "Encrypted token storage", "Updates",
|
||||
"Store the update token in the OS keyring, encrypted (M13)", ("libsecret-tools",), "secret-tool",
|
||||
"Store the update token in the OS keyring, encrypted", ("libsecret-tools",), "secret-tool",
|
||||
),
|
||||
)
|
||||
|
||||
@@ -0,0 +1,203 @@
|
||||
"""System inventory (M5): collect hardware/OS details, exportable to Markdown/JSON.
|
||||
|
||||
Stdlib + tools already used elsewhere (nvidia-smi, lspci, lsblk, dmidecode). Every
|
||||
probe degrades gracefully; board/BIOS/RAM-module details need dmidecode as root.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import os
|
||||
import platform
|
||||
import shutil
|
||||
import subprocess
|
||||
from dataclasses import dataclass
|
||||
from pathlib import Path
|
||||
|
||||
from .. import __version__
|
||||
from . import sysenv
|
||||
|
||||
|
||||
@dataclass
|
||||
class Section:
|
||||
title: str
|
||||
items: list[tuple[str, str]]
|
||||
|
||||
|
||||
def _run(cmd: list[str], timeout: float = 12.0) -> str:
|
||||
try:
|
||||
proc = subprocess.run(cmd, capture_output=True, text=True, timeout=timeout)
|
||||
if proc.returncode == 0:
|
||||
return proc.stdout
|
||||
except (subprocess.SubprocessError, OSError):
|
||||
pass
|
||||
return ""
|
||||
|
||||
|
||||
def _system() -> Section:
|
||||
u = os.uname()
|
||||
return Section("System", [
|
||||
("Distro", sysenv.distro_name()),
|
||||
("Kernel", u.release),
|
||||
("Architecture", u.machine),
|
||||
("Hostname", u.nodename),
|
||||
("Python", platform.python_version()),
|
||||
("RigDoctor", __version__),
|
||||
])
|
||||
|
||||
|
||||
def _cpu() -> Section:
|
||||
model = "?"
|
||||
threads = 0
|
||||
core_ids: set[tuple[str, str]] = set()
|
||||
phys = "0"
|
||||
try:
|
||||
for line in Path("/proc/cpuinfo").read_text().splitlines():
|
||||
if line.startswith("model name") and model == "?":
|
||||
model = line.split(":", 1)[1].strip()
|
||||
elif line.startswith("processor"):
|
||||
threads += 1
|
||||
elif line.startswith("physical id"):
|
||||
phys = line.split(":", 1)[1].strip()
|
||||
elif line.startswith("core id"):
|
||||
core_ids.add((phys, line.split(":", 1)[1].strip()))
|
||||
except OSError:
|
||||
pass
|
||||
items = [("Model", model)]
|
||||
if core_ids:
|
||||
items.append(("Cores", str(len(core_ids))))
|
||||
items.append(("Threads", str(threads or os.cpu_count() or "?")))
|
||||
return Section("CPU", items)
|
||||
|
||||
|
||||
def _firmware(dmi: dict) -> Section:
|
||||
board = dmi.get("baseboard", {})
|
||||
bios = dmi.get("bios", {})
|
||||
items: list[tuple[str, str]] = []
|
||||
if board:
|
||||
items.append(("Motherboard", f"{board.get('Manufacturer', '')} {board.get('Product Name', '')}".strip()))
|
||||
if bios:
|
||||
items.append(("BIOS", f"{bios.get('Vendor', '')} {bios.get('Version', '')}".strip()))
|
||||
if bios.get("Release Date"):
|
||||
items.append(("BIOS date", bios["Release Date"]))
|
||||
if not items:
|
||||
items = [("Motherboard / BIOS", "run with admin (dmidecode needs root)")]
|
||||
return Section("Firmware", items)
|
||||
|
||||
|
||||
def _memory(dmi: dict) -> Section:
|
||||
items: list[tuple[str, str]] = []
|
||||
try:
|
||||
for line in Path("/proc/meminfo").read_text().splitlines():
|
||||
if line.startswith("MemTotal"):
|
||||
items.append(("Total", f"{int(line.split()[1]) / 1024 / 1024:.1f} GB"))
|
||||
break
|
||||
except (OSError, ValueError, IndexError):
|
||||
pass
|
||||
modules = dmi.get("memory", [])
|
||||
if modules:
|
||||
items.append(("Modules", str(len(modules))))
|
||||
for i, m in enumerate(modules):
|
||||
desc = " · ".join(p for p in (m.get("Size"), m.get("Type"), m.get("Speed"), m.get("Part Number")) if p)
|
||||
items.append((f"Slot {i}", desc))
|
||||
elif shutil.which("dmidecode"):
|
||||
items.append(("Modules", "run with admin for module details"))
|
||||
return Section("Memory", items)
|
||||
|
||||
|
||||
def _gpu() -> Section:
|
||||
if shutil.which("nvidia-smi"):
|
||||
out = _run([
|
||||
"nvidia-smi",
|
||||
"--query-gpu=name,driver_version,vbios_version,memory.total,pcie.link.gen.max,pcie.link.width.max",
|
||||
"--format=csv,noheader",
|
||||
])
|
||||
line = out.strip().splitlines()[0] if out.strip() else ""
|
||||
if line:
|
||||
cols = [c.strip() for c in line.split(",")]
|
||||
keys = ["Name", "Driver", "VBIOS", "VRAM", "PCIe gen (max)", "PCIe width (max)"]
|
||||
return Section("GPU", list(zip(keys, cols)))
|
||||
out = _run(["lspci"])
|
||||
gpus = [ln.split(":", 2)[-1].strip() for ln in out.splitlines()
|
||||
if "VGA compatible controller" in ln or "3D controller" in ln]
|
||||
return Section("GPU", [("Device", g) for g in gpus] or [("Device", "unknown")])
|
||||
|
||||
|
||||
def _storage() -> Section:
|
||||
items: list[tuple[str, str]] = []
|
||||
# TYPE first so MODEL (which can contain spaces) is the trailing field.
|
||||
out = _run(["lsblk", "-dn", "-o", "TYPE,NAME,SIZE,MODEL"])
|
||||
for line in out.strip().splitlines():
|
||||
parts = line.split(None, 3)
|
||||
if len(parts) < 3 or parts[0] != "disk": # skip loop/zram/rom devices
|
||||
continue
|
||||
name, size = parts[1], parts[2]
|
||||
model = parts[3] if len(parts) > 3 else ""
|
||||
items.append((name, f"{model} ({size})".strip()))
|
||||
return Section("Storage", items or [("Disks", "unknown")])
|
||||
|
||||
|
||||
def _display() -> Section:
|
||||
return Section("Display", [
|
||||
("Session", os.environ.get("XDG_SESSION_TYPE", "unknown")),
|
||||
("Desktop", os.environ.get("XDG_CURRENT_DESKTOP") or os.environ.get("DESKTOP_SESSION", "unknown")),
|
||||
])
|
||||
|
||||
|
||||
def _dmidecode() -> dict:
|
||||
if not shutil.which("dmidecode"):
|
||||
return {}
|
||||
out = _run(["dmidecode", "-t", "baseboard", "-t", "bios", "-t", "memory"], timeout=15)
|
||||
if not out.strip():
|
||||
return {}
|
||||
result: dict = {"baseboard": {}, "bios": {}, "memory": []}
|
||||
for block in out.split("Handle "):
|
||||
lines = block.splitlines()
|
||||
if len(lines) < 2:
|
||||
continue
|
||||
title = lines[1].strip()
|
||||
kv: dict[str, str] = {}
|
||||
for ln in lines[2:]:
|
||||
if ln.startswith("\t") and ":" in ln:
|
||||
key, _, value = ln.strip().partition(":")
|
||||
kv[key.strip()] = value.strip()
|
||||
if title == "Base Board Information":
|
||||
result["baseboard"] = kv
|
||||
elif title == "BIOS Information":
|
||||
result["bios"] = kv
|
||||
elif title == "Memory Device" and kv.get("Size") and kv["Size"] != "No Module Installed":
|
||||
result["memory"].append(kv)
|
||||
return result
|
||||
|
||||
|
||||
def collect() -> list[Section]:
|
||||
dmi = _dmidecode()
|
||||
return [_system(), _cpu(), _firmware(dmi), _memory(dmi), _gpu(), _storage(), _display()]
|
||||
|
||||
|
||||
def to_dict(sections: list[Section]) -> dict:
|
||||
return {s.title: dict(s.items) for s in sections}
|
||||
|
||||
|
||||
def from_dict(data: dict) -> list[Section]:
|
||||
return [Section(title, list(items.items())) for title, items in data.items()]
|
||||
|
||||
|
||||
def render_markdown(sections: list[Section]) -> str:
|
||||
out = ["# RigDoctor system inventory", ""]
|
||||
for s in sections:
|
||||
out.append(f"## {s.title}")
|
||||
out += [f"- **{k}:** {v}" for k, v in s.items]
|
||||
out.append("")
|
||||
return "\n".join(out).strip() + "\n"
|
||||
|
||||
|
||||
def render_text(sections: list[Section]) -> str:
|
||||
blocks = []
|
||||
for s in sections:
|
||||
blocks.append("\n".join([s.title] + [f" {k:<18} {v}" for k, v in s.items]))
|
||||
return "\n\n".join(blocks)
|
||||
|
||||
|
||||
def render_json(sections: list[Section]) -> str:
|
||||
return json.dumps(to_dict(sections), indent=2, ensure_ascii=False)
|
||||
@@ -0,0 +1,41 @@
|
||||
"""Uninstall the user-local RigDoctor install (app files; optionally all data).
|
||||
|
||||
Mirrors `install.sh --uninstall`. The removal runs in a detached shell so it can
|
||||
delete the venv the current process is running from once we exit.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import shlex
|
||||
import subprocess
|
||||
from pathlib import Path
|
||||
|
||||
from .. import config
|
||||
from . import reccontrol
|
||||
|
||||
|
||||
def targets(purge: bool = False) -> list[Path]:
|
||||
"""Paths removed by an uninstall. With purge, also config/state/logs."""
|
||||
home = Path.home()
|
||||
share = config.DATA_DIR.parent # ~/.local/share
|
||||
items = [
|
||||
config.DATA_DIR / "venv",
|
||||
home / ".local" / "bin" / "rigdoctor",
|
||||
home / ".local" / "bin" / "rigdoctor-gui",
|
||||
share / "applications" / "rigdoctor.desktop",
|
||||
]
|
||||
if purge:
|
||||
items += [config.CONFIG_DIR, config.STATE_DIR, config.DATA_DIR]
|
||||
return items
|
||||
|
||||
|
||||
def uninstall(purge: bool = False) -> None:
|
||||
"""Stop the recorder, clear the token if purging, and remove the install."""
|
||||
reccontrol.stop_background()
|
||||
if purge:
|
||||
config.clear_token() # removes keyring entry + any file fallback
|
||||
paths = " ".join(shlex.quote(str(p)) for p in targets(purge))
|
||||
subprocess.Popen(
|
||||
["/bin/sh", "-c", f"sleep 1; rm -rf {paths}"],
|
||||
start_new_session=True,
|
||||
)
|
||||
@@ -1,9 +1,9 @@
|
||||
"""Update check (M13): ask the Gitea releases API for the latest version.
|
||||
"""Update check (M13): ask the Gitea releases API for the latest version + notes.
|
||||
|
||||
Stdlib-only (urllib). The Gitea instance requires sign-in, so updates are gated to
|
||||
account holders via a Personal Access Token (D18): set $RIGDOCTOR_TOKEN or save one
|
||||
with `rigdoctor login`. Self-update (apply) is built on top of this; this module
|
||||
handles detection and exposes a clear state for the UI.
|
||||
with `rigdoctor login`. Returns the latest tag, its release notes (body), and a clear
|
||||
state for the UI; `apply_update` performs the no-root self-update.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
@@ -42,11 +42,11 @@ def is_newer(latest: str, current: str = __version__) -> bool:
|
||||
return False
|
||||
|
||||
|
||||
def fetch_latest(timeout: float = 5.0) -> tuple[str | None, str | None]:
|
||||
"""Return (tag, error). error is one of NO_TOKEN / AUTH / NETWORK, or None on success."""
|
||||
def fetch_latest(timeout: float = 5.0) -> tuple[str | None, str, str | None]:
|
||||
"""Return (tag, notes, error). error is NO_TOKEN/AUTH/NETWORK, or None on success."""
|
||||
token = load_token()
|
||||
if not token:
|
||||
return (None, NO_TOKEN)
|
||||
return (None, "", NO_TOKEN)
|
||||
req = urllib.request.Request(
|
||||
LATEST_API,
|
||||
headers={"Accept": "application/json", "Authorization": f"token {token}"},
|
||||
@@ -54,27 +54,49 @@ def fetch_latest(timeout: float = 5.0) -> tuple[str | None, str | None]:
|
||||
try:
|
||||
with urllib.request.urlopen(req, timeout=timeout) as resp: # noqa: S310 (https)
|
||||
data = json.load(resp)
|
||||
return (data.get("tag_name") or None, None)
|
||||
return (data.get("tag_name") or None, (data.get("body") or "").strip(), None)
|
||||
except urllib.error.HTTPError as exc:
|
||||
return (None, AUTH if exc.code in (401, 403) else NETWORK)
|
||||
return (None, "", AUTH if exc.code in (401, 403) else NETWORK)
|
||||
except Exception:
|
||||
return (None, NETWORK)
|
||||
return (None, "", NETWORK)
|
||||
|
||||
|
||||
def check_latest(timeout: float = 5.0) -> str | None:
|
||||
"""Convenience: latest tag or None (ignores error reason)."""
|
||||
tag, _ = fetch_latest(timeout)
|
||||
"""Convenience: latest tag or None (ignores notes/error)."""
|
||||
tag, _notes, _error = fetch_latest(timeout)
|
||||
return tag
|
||||
|
||||
|
||||
def update_state(timeout: float = 5.0) -> tuple[str, str | None]:
|
||||
"""Return (state, tag). state in NO_TOKEN/AUTH/NETWORK/UP_TO_DATE/AVAILABLE."""
|
||||
tag, error = fetch_latest(timeout)
|
||||
def update_state(timeout: float = 5.0) -> tuple[str, str | None, str]:
|
||||
"""Return (state, tag, notes). state in NO_TOKEN/AUTH/NETWORK/UP_TO_DATE/AVAILABLE."""
|
||||
tag, notes, error = fetch_latest(timeout)
|
||||
if error:
|
||||
return (error, None)
|
||||
return (error, None, "")
|
||||
if tag and is_newer(tag):
|
||||
return (AVAILABLE, tag)
|
||||
return (UP_TO_DATE, tag)
|
||||
return (AVAILABLE, tag, notes)
|
||||
return (UP_TO_DATE, tag, notes)
|
||||
|
||||
|
||||
def list_releases(limit: int = 15, timeout: float = 6.0) -> tuple[list[tuple[str, str, str]], str | None]:
|
||||
"""Return ([(tag, date, notes), …], error) for the in-app changelog."""
|
||||
token = load_token()
|
||||
if not token:
|
||||
return ([], NO_TOKEN)
|
||||
req = urllib.request.Request(
|
||||
f"{GITEA_BASE}/api/v1/repos/{REPO}/releases?limit={limit}",
|
||||
headers={"Accept": "application/json", "Authorization": f"token {token}"},
|
||||
)
|
||||
try:
|
||||
with urllib.request.urlopen(req, timeout=timeout) as resp: # noqa: S310 (https)
|
||||
data = json.load(resp)
|
||||
return ([
|
||||
(r.get("tag_name") or "?", (r.get("published_at") or "")[:10], (r.get("body") or "").strip())
|
||||
for r in data
|
||||
], None)
|
||||
except urllib.error.HTTPError as exc:
|
||||
return ([], AUTH if exc.code in (401, 403) else NETWORK)
|
||||
except Exception:
|
||||
return ([], NETWORK)
|
||||
|
||||
|
||||
def apply_update(tag: str) -> tuple[int, str]:
|
||||
|
||||
@@ -2,6 +2,11 @@
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import os
|
||||
import shutil
|
||||
import subprocess
|
||||
import sys
|
||||
import threading
|
||||
import time
|
||||
|
||||
@@ -72,6 +77,11 @@ class HealthPage(QWidget):
|
||||
self._status = QLabel("")
|
||||
self._status.setObjectName("Muted")
|
||||
header.addWidget(self._status)
|
||||
self._admin_btn = QPushButton("Run with admin")
|
||||
self._admin_btn.setToolTip("Run all checks with root (SMART needs it) — prompts for your password")
|
||||
self._admin_btn.clicked.connect(self._run_admin)
|
||||
self._admin_btn.setEnabled(shutil.which("pkexec") is not None)
|
||||
header.addWidget(self._admin_btn)
|
||||
self._run_btn = QPushButton("Run health report")
|
||||
self._run_btn.setObjectName("PrimaryButton")
|
||||
self._run_btn.clicked.connect(self._run)
|
||||
@@ -106,7 +116,34 @@ class HealthPage(QWidget):
|
||||
findings = []
|
||||
self._result.emit(findings)
|
||||
|
||||
def _run_admin(self) -> None:
|
||||
self._run_btn.setEnabled(False)
|
||||
self._admin_btn.setEnabled(False)
|
||||
self._status.setText("Running all checks with admin (you'll be prompted)…")
|
||||
threading.Thread(target=self._work_admin, daemon=True).start()
|
||||
|
||||
def _work_admin(self) -> None:
|
||||
from ..core.health import Finding
|
||||
|
||||
cli = os.path.join(os.path.dirname(sys.executable), "rigdoctor")
|
||||
if os.path.exists(cli):
|
||||
cmd = ["pkexec", cli, "report", "--json"]
|
||||
else: # dev / not on PATH next to python
|
||||
cmd = ["pkexec", sys.executable, "-m", "rigdoctor", "report", "--json"]
|
||||
try:
|
||||
proc = subprocess.run(cmd, capture_output=True, text=True, timeout=180)
|
||||
findings = [Finding(**d) for d in json.loads(proc.stdout)] if proc.returncode == 0 else None
|
||||
except Exception:
|
||||
findings = None # pkexec cancelled / failed / unparsable
|
||||
self._result.emit(findings)
|
||||
|
||||
def _render_findings(self, findings) -> None:
|
||||
self._run_btn.setEnabled(True)
|
||||
self._admin_btn.setEnabled(shutil.which("pkexec") is not None)
|
||||
if findings is None: # elevated run cancelled/failed — keep current results
|
||||
self._status.setText("admin run cancelled")
|
||||
return
|
||||
|
||||
while self._list.count():
|
||||
item = self._list.takeAt(0)
|
||||
w = item.widget()
|
||||
@@ -122,4 +159,3 @@ class HealthPage(QWidget):
|
||||
for finding in findings:
|
||||
self._list.addWidget(_finding_widget(finding))
|
||||
self._list.addStretch(1)
|
||||
self._run_btn.setEnabled(True)
|
||||
|
||||
@@ -0,0 +1,169 @@
|
||||
"""Inventory page (M5 in the GUI): system inventory with copy/save + admin re-collect."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import os
|
||||
import shutil
|
||||
import subprocess
|
||||
import sys
|
||||
import threading
|
||||
|
||||
from PySide6.QtCore import Qt, QTimer, Signal
|
||||
from PySide6.QtWidgets import (
|
||||
QApplication,
|
||||
QFileDialog,
|
||||
QFrame,
|
||||
QGridLayout,
|
||||
QHBoxLayout,
|
||||
QLabel,
|
||||
QPushButton,
|
||||
QScrollArea,
|
||||
QVBoxLayout,
|
||||
QWidget,
|
||||
)
|
||||
|
||||
from ..core import inventory
|
||||
from .theme import MUTED
|
||||
|
||||
|
||||
def _section_card(section) -> QFrame:
|
||||
card = QFrame()
|
||||
card.setObjectName("Card")
|
||||
layout = QVBoxLayout(card)
|
||||
layout.setContentsMargins(16, 12, 16, 12)
|
||||
layout.setSpacing(6)
|
||||
title = QLabel(section.title)
|
||||
title.setStyleSheet("font-weight: 700; background: transparent;")
|
||||
layout.addWidget(title)
|
||||
grid = QGridLayout()
|
||||
grid.setColumnStretch(1, 1)
|
||||
grid.setHorizontalSpacing(14)
|
||||
grid.setVerticalSpacing(4)
|
||||
for row, (key, value) in enumerate(section.items):
|
||||
k = QLabel(key)
|
||||
k.setObjectName("Muted")
|
||||
v = QLabel(value)
|
||||
v.setWordWrap(True)
|
||||
v.setStyleSheet("background: transparent;")
|
||||
grid.addWidget(k, row, 0)
|
||||
grid.addWidget(v, row, 1)
|
||||
layout.addLayout(grid)
|
||||
return card
|
||||
|
||||
|
||||
class InventoryPage(QWidget):
|
||||
_result = Signal(object) # list[Section]
|
||||
|
||||
def __init__(self) -> None:
|
||||
super().__init__()
|
||||
self.setObjectName("Page")
|
||||
self._sections: list = []
|
||||
self._result.connect(self._render)
|
||||
|
||||
root = QVBoxLayout(self)
|
||||
root.setContentsMargins(20, 18, 20, 18)
|
||||
root.setSpacing(16)
|
||||
|
||||
header = QHBoxLayout()
|
||||
title = QLabel("Inventory")
|
||||
title.setObjectName("PageTitle")
|
||||
header.addWidget(title)
|
||||
header.addStretch(1)
|
||||
self._status = QLabel("")
|
||||
self._status.setObjectName("Muted")
|
||||
header.addWidget(self._status)
|
||||
self._admin_btn = QPushButton("Run with admin")
|
||||
self._admin_btn.setToolTip("Re-collect with root for motherboard/BIOS/RAM details (dmidecode)")
|
||||
self._admin_btn.setEnabled(shutil.which("pkexec") is not None)
|
||||
self._admin_btn.clicked.connect(self._run_admin)
|
||||
header.addWidget(self._admin_btn)
|
||||
self._copy_btn = QPushButton("Copy Markdown")
|
||||
self._copy_btn.clicked.connect(self._copy)
|
||||
header.addWidget(self._copy_btn)
|
||||
self._save_btn = QPushButton("Save…")
|
||||
self._save_btn.clicked.connect(self._save)
|
||||
header.addWidget(self._save_btn)
|
||||
self._refresh_btn = QPushButton("Refresh")
|
||||
self._refresh_btn.setObjectName("PrimaryButton")
|
||||
self._refresh_btn.clicked.connect(self._run)
|
||||
header.addWidget(self._refresh_btn)
|
||||
root.addLayout(header)
|
||||
|
||||
scroll = QScrollArea()
|
||||
scroll.setWidgetResizable(True)
|
||||
scroll.setFrameShape(QFrame.Shape.NoFrame)
|
||||
scroll.setStyleSheet("background: transparent;")
|
||||
self._container = QWidget()
|
||||
self._list = QVBoxLayout(self._container)
|
||||
self._list.setContentsMargins(0, 0, 0, 0)
|
||||
self._list.setSpacing(12)
|
||||
self._list.setAlignment(Qt.AlignmentFlag.AlignTop)
|
||||
scroll.setWidget(self._container)
|
||||
root.addWidget(scroll, 1)
|
||||
|
||||
QTimer.singleShot(300, self._run)
|
||||
|
||||
def _run(self) -> None:
|
||||
self._busy("Collecting…")
|
||||
threading.Thread(target=self._work, daemon=True).start()
|
||||
|
||||
def _work(self) -> None:
|
||||
try:
|
||||
sections = inventory.collect()
|
||||
except Exception:
|
||||
sections = []
|
||||
self._result.emit(sections)
|
||||
|
||||
def _run_admin(self) -> None:
|
||||
self._busy("Collecting with admin (you'll be prompted)…")
|
||||
threading.Thread(target=self._work_admin, daemon=True).start()
|
||||
|
||||
def _work_admin(self) -> None:
|
||||
cli = os.path.join(os.path.dirname(sys.executable), "rigdoctor")
|
||||
cmd = [cli, "inventory", "--json"] if os.path.exists(cli) else [sys.executable, "-m", "rigdoctor", "inventory", "--json"]
|
||||
try:
|
||||
proc = subprocess.run(["pkexec", *cmd], capture_output=True, text=True, timeout=120)
|
||||
sections = inventory.from_dict(json.loads(proc.stdout)) if proc.returncode == 0 else None
|
||||
except Exception:
|
||||
sections = None
|
||||
self._result.emit(sections)
|
||||
|
||||
def _busy(self, text: str) -> None:
|
||||
self._status.setText(text)
|
||||
for b in (self._refresh_btn, self._admin_btn, self._copy_btn, self._save_btn):
|
||||
b.setEnabled(False)
|
||||
|
||||
def _render(self, sections) -> None:
|
||||
self._refresh_btn.setEnabled(True)
|
||||
self._admin_btn.setEnabled(shutil.which("pkexec") is not None)
|
||||
self._copy_btn.setEnabled(True)
|
||||
self._save_btn.setEnabled(True)
|
||||
if sections is None: # admin run cancelled/failed — keep current
|
||||
self._status.setText("admin run cancelled")
|
||||
return
|
||||
|
||||
self._sections = sections
|
||||
while self._list.count():
|
||||
item = self._list.takeAt(0)
|
||||
w = item.widget()
|
||||
if w is not None:
|
||||
w.deleteLater()
|
||||
for section in sections:
|
||||
self._list.addWidget(_section_card(section))
|
||||
self._list.addStretch(1)
|
||||
self._status.setText("")
|
||||
|
||||
def _copy(self) -> None:
|
||||
if self._sections:
|
||||
QApplication.clipboard().setText(inventory.render_markdown(self._sections))
|
||||
self._status.setText("copied as Markdown")
|
||||
|
||||
def _save(self) -> None:
|
||||
if not self._sections:
|
||||
return
|
||||
path, _ = QFileDialog.getSaveFileName(self, "Save inventory", "rigdoctor-inventory.md", "Markdown (*.md)")
|
||||
if path:
|
||||
with open(path, "w", encoding="utf-8") as f:
|
||||
f.write(inventory.render_markdown(self._sections))
|
||||
self._status.setText(f"saved {os.path.basename(path)}")
|
||||
@@ -2,39 +2,46 @@
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import sys
|
||||
import threading
|
||||
|
||||
from PySide6.QtCore import Qt, Signal
|
||||
from PySide6.QtCore import Qt, QProcess, QTimer, Signal
|
||||
from PySide6.QtGui import QTextDocument
|
||||
from PySide6.QtWidgets import (
|
||||
QApplication,
|
||||
QButtonGroup,
|
||||
QDialog,
|
||||
QFrame,
|
||||
QHBoxLayout,
|
||||
QLabel,
|
||||
QMainWindow,
|
||||
QMessageBox,
|
||||
QPushButton,
|
||||
QStackedWidget,
|
||||
QTextEdit,
|
||||
QVBoxLayout,
|
||||
QWidget,
|
||||
)
|
||||
|
||||
from .. import __version__
|
||||
from ..config import load_config
|
||||
from ..core import updates
|
||||
from .dashboard import Dashboard
|
||||
from .health_page import HealthPage
|
||||
from .inventory_page import InventoryPage
|
||||
from .recorder_page import RecorderPage
|
||||
from .setup_page import SetupPage
|
||||
from .theme import ACCENT, GOOD, MUTED
|
||||
from .worker import SamplerWorker
|
||||
|
||||
_NAV_ITEMS = ["Dashboard", "Logs", "Health", "Setup", "Inventory"]
|
||||
_PLACEHOLDERS = {
|
||||
"Inventory": "System inventory (M5) — CPU/GPU/board/RAM/drivers — lands here.",
|
||||
}
|
||||
|
||||
|
||||
class MainWindow(QMainWindow):
|
||||
_update_checked = Signal(object) # (state, tag)
|
||||
_update_checked = Signal(object) # (state, tag, notes)
|
||||
_update_applied = Signal(int) # pip exit code
|
||||
_changelog_ready = Signal(object) # ([(tag, date, notes)], error)
|
||||
|
||||
def __init__(self, interval: float = 1.0) -> None:
|
||||
super().__init__()
|
||||
@@ -57,11 +64,12 @@ class MainWindow(QMainWindow):
|
||||
self.recorder_page = RecorderPage()
|
||||
self.health_page = HealthPage()
|
||||
self.setup_page = SetupPage()
|
||||
self.inventory_page = InventoryPage()
|
||||
self._stack.addWidget(self.dashboard) # 0 Dashboard
|
||||
self._stack.addWidget(self.recorder_page) # 1 Logs
|
||||
self._stack.addWidget(self.health_page) # 2 Health
|
||||
self._stack.addWidget(self.setup_page) # 3 Setup
|
||||
self._stack.addWidget(self._placeholder_page("Inventory", _PLACEHOLDERS["Inventory"])) # 4
|
||||
self._stack.addWidget(self.inventory_page) # 4 Inventory
|
||||
content_layout.addWidget(self._stack)
|
||||
|
||||
layout.addWidget(self._build_sidebar())
|
||||
@@ -71,11 +79,21 @@ class MainWindow(QMainWindow):
|
||||
self._worker.sampled.connect(self.dashboard.update_sample)
|
||||
self._worker.start()
|
||||
|
||||
# Background update check (M13); result lands in the sidebar.
|
||||
# Update check (M13): once at launch, then periodically so a newly published
|
||||
# release is detected without restarting (interval from config; 0 disables).
|
||||
self._latest_tag = None
|
||||
self._latest_notes = ""
|
||||
self._applied = False
|
||||
self._update_checked.connect(self._show_update_state)
|
||||
self._update_applied.connect(self._on_update_applied)
|
||||
threading.Thread(target=self._check_updates, daemon=True).start()
|
||||
self._changelog_ready.connect(self._on_changelog)
|
||||
self._start_update_check()
|
||||
minutes = float(load_config().get("update_check_minutes", 30) or 0)
|
||||
if minutes > 0:
|
||||
self._update_timer = QTimer(self)
|
||||
self._update_timer.setInterval(int(minutes * 60_000))
|
||||
self._update_timer.timeout.connect(self._start_update_check)
|
||||
self._update_timer.start()
|
||||
|
||||
def _build_sidebar(self) -> QFrame:
|
||||
bar = QFrame()
|
||||
@@ -111,6 +129,16 @@ class MainWindow(QMainWindow):
|
||||
version = QLabel(f"v{__version__}")
|
||||
version.setObjectName("Muted")
|
||||
v.addWidget(version)
|
||||
changelog_btn = QPushButton("Changelog")
|
||||
changelog_btn.setObjectName("LinkButton")
|
||||
changelog_btn.setCursor(Qt.CursorShape.PointingHandCursor)
|
||||
changelog_btn.clicked.connect(self._show_changelog)
|
||||
v.addWidget(changelog_btn)
|
||||
check_btn = QPushButton("Check for updates")
|
||||
check_btn.setObjectName("LinkButton")
|
||||
check_btn.setCursor(Qt.CursorShape.PointingHandCursor)
|
||||
check_btn.clicked.connect(self._manual_check)
|
||||
v.addWidget(check_btn)
|
||||
|
||||
# Update state (filled in by the background check).
|
||||
self._update_label = QLabel("checking for updates…")
|
||||
@@ -122,11 +150,35 @@ class MainWindow(QMainWindow):
|
||||
self._update_btn.clicked.connect(self._apply_update)
|
||||
self._update_btn.setVisible(False)
|
||||
v.addWidget(self._update_btn)
|
||||
self._restart_btn = QPushButton("Restart now")
|
||||
self._restart_btn.setObjectName("PrimaryButton")
|
||||
self._restart_btn.setCursor(Qt.CursorShape.PointingHandCursor)
|
||||
self._restart_btn.clicked.connect(self._restart)
|
||||
self._restart_btn.setVisible(False)
|
||||
v.addWidget(self._restart_btn)
|
||||
return bar
|
||||
|
||||
def _restart(self) -> None:
|
||||
gui = os.path.join(os.path.dirname(sys.executable), "rigdoctor-gui")
|
||||
if os.path.exists(gui):
|
||||
QProcess.startDetached(gui)
|
||||
else: # dev / not installed next to python
|
||||
QProcess.startDetached(sys.executable, sys.argv)
|
||||
QApplication.instance().quit()
|
||||
|
||||
def _apply_update(self) -> None:
|
||||
if not self._latest_tag:
|
||||
return
|
||||
box = QMessageBox(self)
|
||||
box.setWindowTitle(f"Update to {self._latest_tag}")
|
||||
box.setText(f"Update RigDoctor to {self._latest_tag}?")
|
||||
notes_doc = QTextDocument()
|
||||
notes_doc.setMarkdown(self._latest_notes or "_(no release notes)_")
|
||||
box.setInformativeText(notes_doc.toHtml()) # render Markdown as rich text (#1)
|
||||
box.setStandardButtons(QMessageBox.StandardButton.Ok | QMessageBox.StandardButton.Cancel)
|
||||
box.button(QMessageBox.StandardButton.Ok).setText("Update")
|
||||
if box.exec() != QMessageBox.StandardButton.Ok:
|
||||
return
|
||||
self._update_btn.setEnabled(False)
|
||||
self._update_label.setText("updating…")
|
||||
tag = self._latest_tag
|
||||
@@ -134,18 +186,68 @@ class MainWindow(QMainWindow):
|
||||
|
||||
def _on_update_applied(self, rc: int) -> None:
|
||||
if rc == 0:
|
||||
self._update_label.setText("updated — restart RigDoctor")
|
||||
self._applied = True
|
||||
self._update_label.setText("update installed")
|
||||
self._update_btn.setVisible(False)
|
||||
self._restart_btn.setVisible(True)
|
||||
if hasattr(self, "_update_timer"):
|
||||
self._update_timer.stop()
|
||||
else:
|
||||
self._update_label.setText("update failed")
|
||||
self._update_btn.setEnabled(True)
|
||||
|
||||
def _manual_check(self) -> None:
|
||||
if self._applied:
|
||||
return
|
||||
self._update_label.setText("checking for updates…")
|
||||
self._start_update_check()
|
||||
|
||||
def _start_update_check(self) -> None:
|
||||
threading.Thread(target=self._check_updates, daemon=True).start()
|
||||
|
||||
def _show_changelog(self) -> None:
|
||||
dialog = QDialog(self)
|
||||
dialog.setWindowTitle("RigDoctor — Changelog")
|
||||
dialog.resize(560, 540)
|
||||
layout = QVBoxLayout(dialog)
|
||||
view = QTextEdit()
|
||||
view.setObjectName("Report")
|
||||
view.setReadOnly(True)
|
||||
view.setPlainText("Loading…")
|
||||
layout.addWidget(view)
|
||||
self._changelog_view = view
|
||||
dialog.show()
|
||||
threading.Thread(target=self._fetch_changelog, daemon=True).start()
|
||||
|
||||
def _fetch_changelog(self) -> None:
|
||||
self._changelog_ready.emit(updates.list_releases())
|
||||
|
||||
def _on_changelog(self, result) -> None:
|
||||
view = getattr(self, "_changelog_view", None)
|
||||
if view is None:
|
||||
return
|
||||
releases, error = result
|
||||
if error == updates.NO_TOKEN:
|
||||
view.setPlainText("Add an update token (Setup → Update access) to load the changelog.")
|
||||
return
|
||||
if error or not releases:
|
||||
view.setPlainText("Couldn't load the changelog from the update server.")
|
||||
return
|
||||
blocks = []
|
||||
for tag, date, notes in releases:
|
||||
title = f"## {tag}" + (f" — {date}" if date else "")
|
||||
blocks.append(f"{title}\n\n{notes or '_(no notes)_'}")
|
||||
view.setMarkdown("\n\n".join(blocks)) # render Markdown instead of raw text (#1)
|
||||
|
||||
def _check_updates(self) -> None:
|
||||
self._update_checked.emit(updates.update_state())
|
||||
|
||||
def _show_update_state(self, result) -> None:
|
||||
state, tag = result
|
||||
if self._applied: # an update was applied this session; awaiting restart
|
||||
return
|
||||
state, tag, notes = result
|
||||
self._latest_tag = tag
|
||||
self._latest_notes = notes
|
||||
self._update_btn.setVisible(False)
|
||||
if state == updates.NO_TOKEN:
|
||||
self._update_label.setText("connect to update server")
|
||||
@@ -160,29 +262,6 @@ class MainWindow(QMainWindow):
|
||||
else: # UP_TO_DATE
|
||||
self._update_label.setText("up-to-date")
|
||||
|
||||
def _placeholder_page(self, title: str, description: str) -> QWidget:
|
||||
page = QWidget()
|
||||
page.setObjectName("Page")
|
||||
v = QVBoxLayout(page)
|
||||
v.setContentsMargins(20, 18, 20, 18)
|
||||
v.setSpacing(16)
|
||||
head = QLabel(title)
|
||||
head.setObjectName("PageTitle")
|
||||
v.addWidget(head)
|
||||
|
||||
card = QFrame()
|
||||
card.setObjectName("Card")
|
||||
cv = QVBoxLayout(card)
|
||||
cv.setContentsMargins(24, 48, 24, 48)
|
||||
msg = QLabel(description)
|
||||
msg.setObjectName("Muted")
|
||||
msg.setWordWrap(True)
|
||||
msg.setAlignment(Qt.AlignmentFlag.AlignCenter)
|
||||
cv.addWidget(msg)
|
||||
v.addWidget(card)
|
||||
v.addStretch(1)
|
||||
return page
|
||||
|
||||
def closeEvent(self, event) -> None: # noqa: N802 (Qt override)
|
||||
self._worker.stop()
|
||||
super().closeEvent(event)
|
||||
|
||||
@@ -7,10 +7,12 @@ import threading
|
||||
from PySide6.QtCore import Qt, QUrl, Signal
|
||||
from PySide6.QtGui import QDesktopServices
|
||||
from PySide6.QtWidgets import (
|
||||
QApplication,
|
||||
QFrame,
|
||||
QHBoxLayout,
|
||||
QLabel,
|
||||
QLineEdit,
|
||||
QMessageBox,
|
||||
QPushButton,
|
||||
QSizePolicy,
|
||||
QTextEdit,
|
||||
@@ -19,7 +21,7 @@ from PySide6.QtWidgets import (
|
||||
)
|
||||
|
||||
from .. import config
|
||||
from ..core import installer, sysenv, updates
|
||||
from ..core import installer, sysenv, uninstall, updates
|
||||
from .theme import GOOD, MUTED, WARN
|
||||
|
||||
|
||||
@@ -113,9 +115,41 @@ class SetupPage(QWidget):
|
||||
root.addWidget(self._output)
|
||||
root.addStretch(1)
|
||||
|
||||
danger = QHBoxLayout()
|
||||
danger.addStretch(1)
|
||||
uninstall_btn = QPushButton("Uninstall RigDoctor")
|
||||
uninstall_btn.setObjectName("DangerButton")
|
||||
uninstall_btn.clicked.connect(self._uninstall)
|
||||
danger.addWidget(uninstall_btn)
|
||||
root.addLayout(danger)
|
||||
|
||||
self._refresh()
|
||||
self._refresh_update_status()
|
||||
|
||||
def _uninstall(self) -> None:
|
||||
box = QMessageBox(self)
|
||||
box.setIcon(QMessageBox.Icon.Warning)
|
||||
box.setWindowTitle("Uninstall RigDoctor")
|
||||
box.setText("Uninstall RigDoctor?")
|
||||
box.setInformativeText(
|
||||
"This removes the app. Choose “Remove all” to also delete your settings, "
|
||||
"update token, and captured logs."
|
||||
)
|
||||
remove_all = box.addButton("Remove all", QMessageBox.ButtonRole.DestructiveRole)
|
||||
app_only = box.addButton("Uninstall", QMessageBox.ButtonRole.AcceptRole)
|
||||
box.addButton("Cancel", QMessageBox.ButtonRole.RejectRole)
|
||||
box.exec()
|
||||
clicked = box.clickedButton()
|
||||
if clicked is remove_all:
|
||||
purge = True
|
||||
elif clicked is app_only:
|
||||
purge = False
|
||||
else:
|
||||
return
|
||||
uninstall.uninstall(purge=purge)
|
||||
QMessageBox.information(self, "RigDoctor", "Uninstalling… RigDoctor will close now.")
|
||||
QApplication.instance().quit()
|
||||
|
||||
def _refresh(self) -> None:
|
||||
self._env.setText(
|
||||
f"Distro: {sysenv.distro_name()} "
|
||||
@@ -185,7 +219,7 @@ class SetupPage(QWidget):
|
||||
self._upd_state.emit((config.token_backend(), updates.update_state()))
|
||||
|
||||
def _on_upd_state(self, result) -> None:
|
||||
backend, (state, tag) = result
|
||||
backend, (state, tag, _notes) = result
|
||||
msg = {
|
||||
updates.NO_TOKEN: "paste a token below to enable updates",
|
||||
updates.AUTH: "token rejected — check its scope/permissions",
|
||||
|
||||
@@ -107,4 +107,21 @@ QDoubleSpinBox, QSpinBox {{
|
||||
QTextEdit#Report {{
|
||||
background: #0d0f13; color: #cfd3da; border: 1px solid {CARD_BORDER}; border-radius: 8px;
|
||||
}}
|
||||
|
||||
QPushButton#DangerButton {{
|
||||
background: transparent; color: {CRIT}; border: 1px solid {CRIT};
|
||||
border-radius: 8px; padding: 7px 14px;
|
||||
}}
|
||||
QPushButton#DangerButton:hover {{ background: {CRIT}; color: #1a0d0d; }}
|
||||
|
||||
QPushButton#LinkButton {{
|
||||
background: transparent; border: none; color: {MUTED};
|
||||
text-align: left; padding: 0; text-decoration: underline;
|
||||
}}
|
||||
QPushButton#LinkButton:hover {{ color: {TEXT}; }}
|
||||
|
||||
/* Dialogs (update prompt, changelog) — match the dark theme so text is readable. */
|
||||
QDialog {{ background: {BG}; }}
|
||||
QMessageBox {{ background: {CARD}; }}
|
||||
QDialog QLabel, QMessageBox QLabel {{ color: {TEXT}; background: transparent; }}
|
||||
"""
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
"""Tests for the M5 system inventory (render + dict round-trip; collect on real system)."""
|
||||
|
||||
import unittest
|
||||
|
||||
from rigdoctor.core import inventory
|
||||
from rigdoctor.core.inventory import Section
|
||||
|
||||
|
||||
class InventoryTests(unittest.TestCase):
|
||||
def test_collect_returns_sections(self):
|
||||
sections = inventory.collect()
|
||||
self.assertTrue(sections)
|
||||
titles = {s.title for s in sections}
|
||||
self.assertIn("System", titles)
|
||||
self.assertIn("CPU", titles)
|
||||
|
||||
def test_dict_round_trip(self):
|
||||
sections = [Section("System", [("Kernel", "7.0.0"), ("Distro", "Ubuntu")])]
|
||||
restored = inventory.from_dict(inventory.to_dict(sections))
|
||||
self.assertEqual(restored[0].title, "System")
|
||||
self.assertEqual(restored[0].items, [("Kernel", "7.0.0"), ("Distro", "Ubuntu")])
|
||||
|
||||
def test_render_markdown(self):
|
||||
md = inventory.render_markdown([Section("CPU", [("Model", "Test CPU")])])
|
||||
self.assertIn("## CPU", md)
|
||||
self.assertIn("- **Model:** Test CPU", md)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
unittest.main()
|
||||
Reference in New Issue
Block a user