FreeCAD / FreeCAD/Addons

PushNotification

Open
#133 2 comments 0 reactions 0 assignees View on GitHub
+ 💿 𝗔𝗱𝗱𝗼𝗻
Dominant language
No language data
Stars
16
Forks
13
Avg merge
10h 26m
Merged PRs (30d)
18

Description

### 🔌 Repository

https://github.com/mlaffran/PushNotification

### 📑 Notes

**PushNotification** sends push notifications (via [ntfy](https://ntfy.sh)) 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.

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue names the PushNotification repository but no file, test, or explicit change for FreeCAD/Addons. Start by reading the Addons repository's contribution and addon-index conventions, then compare existing entries. Done should be defined as a valid, reviewable Addons entry or another maintainer-confirmed integration outcome.

Written by the indexing model from the issue text.

Assessment

Domain
tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.