Sparkle for Flet (automatic updates on MacOS / Windows)

[ap4499]

What
Sparkle integration for Flet applications, enabling automatic updates on macOS (and Windows).

Where
Repo is here, along with instructions on how to use this within projects: https://github.com/ap4499/sparkle_auto_updater

How
It uses the extension framework introduced in 0.27.6 to create a non-visual widget, that attaches to the overlay.

Example: https://github.com/ap4499/sparkle_auto_updater/blob/main/examples/sparkle_auto_updater_example/src/main.py

Upstream projects
It uses the leanflutter/auto_updater Flutter extension which itself utilizes the Sparkle Project. The benefit of using the Flutter extension, rather than directly using Sparkle, is the Flutter dev has helpfully also setup Winsparkle - this fits well with the cross platform nature of both Flet and Flutter.

Demo
https://github.com/user-attachments/assets/0d5cf35c-dd2f-4afa-afc0-b2f3adf5d9af

Look out for the change in the text below the button - it changes after the application update.

The first example, is when the application defaults have been cleared out. The second, is where they have not - and we get to see how it can be triggered by a Flet button press.

Limitations
Currently, I've only tested it on MacOS. I may later work on Windows - but that is tbc.

Further information

• The entire workflow very quickly falls back to the established Sparkle framework, which will enable you to use external guides to help you setup.
• The best way of obtaining your keys is by using Sparkle directly. The same goes for creating hashes/signing updates, use Sparkle directly.
• I've included a small note at the bottom of the readme for the above, and the specific Sparkle download you will need.
• The key steps that you will need to perform within Flet (and it's packaging environment), have been sign posted on the readme.
• For my own application, I host the application package on a public Github as MacOS makes it almost mandatory to utilise a service that is HTTPS. Github also removes a whole host of other obstacles, such as choosing a CDN as well as bandwidth considerations.