PushNotification

[mlaffran]

🔌 Repository

https://github.com/mlaffran/PushNotification

📑 Notes

PushNotification sends push notifications (via ntfy) when something happens in FreeCAD — a document is saved, an error occurs, or a long-running task such as a render, export, FEM analysis, or simulation finishes.

Key features:

• Toolbar/menu commands: custom notification, quick success/error/render-done notifications, and a connection test.
• Opt-in automatic notifications on document save and FreeCAD errors.
• NotificationDefinition document objects: per-document rules with a configurable trigger (save, error, simulation finished) and templated message/title ({doc}, {filename}, {error} placeholders).
• Macro API (notify(), notify_success(), notify_error(), etc.) for use in custom scripts.
• Auth token stored via the OS credential store (keyring) when available, with a documented plaintext fallback.

License: GPL-3.0-or-later.

Tested on FreeCAD 1.1.0 on macOS. This is a first public release — feedback and issues welcome.

[chennes]

Thanks for the submission, @mlaffran -- there are a few changes that I think should be made before this gets added to the official Index:

1. You need to submit a request that keyring be added to the list of allowed packages, otherwise the Addon Manager will refuse to install it.
2. You should make the default ntfy public topic more secure: add on some sort of randomness at the end, instead of using the hard-coded value that's the same for every installation.
3. When a send fails, the worker thread calls PrintError. But the re-entrancy guard is threading.local(), so the hooked PrintError in that thread sees busy=False and dispatches another notification, which spawns another thread, which fails again, and again... and again. Etc.
4. Monkey-patch of PrintError happens unconditionally, even if you don't open the workbench or take any action. Considering the centrality of PrintError to FreeCAD's internal error reporting, I'd seriously consider how badly you really need/want to hook that deeply into the console. I'd bet that for most users, hooking into slotRecomputedDocument and/or slotRecomputedObject and just checking obj.State would get you basically all you actually need. If you do really need it, install the patch lazily based on some user action (and make sure you call uninstall_hooks() when done!