check workbench update with AddonManager

[rockn]

Hello,
I would like to know if it's possible to check the up to date status of an installed workbench with the help of the AddonManager module ?

Something like :

Code: Select all

import AddonManager
uptodate = AddonManager.checkWB('My Workbench')
uptodate
>>> [False, 10 commits behind]
>>> [True, 0 commitsbehind] 

The goal is to make a check for update when wortkbench is activated, and this without the need to code some fetching functions in the Init of the workbench.

For reference : i found this thread https://forum.freecadweb.org/viewtopic.php?f=10&t=27621 but I'm wondering if it can be done though addonmanager.

[Kunda1]

This is a great idea. posting in order to subscribe to this thread since this should be documented if it exists.

[yorik]

I did something like that for the BIM workbench already:
https://github.com/yorikvanhavre/BIM_Wo ... ds.py#L635
We could make the worker class usable for other workbenches too, something like def __init__(self,workbenchname) and add it to the Addon code...

[DeepSOIC]

could we also offer releases somehow? Or branch selection? I would like to leave a branch of part-o-magic that works with 0.17/0.18, and continue to advance it using new stuff in 0.19 without the burden of backward compatibility.

[vocx]

could we also offer releases somehow? Or branch selection? I would like to leave a branch of part-o-magic that works with 0.17/0.18, and continue to advance it using new stuff in 0.19 without the burden of backward compatibility.

I think this is basically what Roy is requesting in this other thread BIM Addon version nr?

I guess the addons aren't particularly tracked. Developers mostly use a rolling release model, although I've seen a few who actually name a few releases as v1, v2, etc.

[Kunda1]

I guess the addons aren't particularly tracked. Developers mostly use a rolling release model, although I've seen a few who actually name a few releases as v1, v2, etc.

Yes, the rolling release model is the dominant paradigm.

Edit: hard to track and troubleshoot. I was at one point advocating for https://github.com/FreeCAD/FreeCAD-addons/issues/105 (Document how Workbench creators can inject WB version in to About FreeCAD dialog)

[TheMarkster]

It would be better if the addon manager can do this check on startup for all installed workbenches / macros? This would relieve the addon authors from all having to implement update checking code into their macros / workbenches.

I'm thinking having the addon manager run on startup in the background, hidden. It does the same check it does now, and if updates are found, the user gets notified and asked whether to update now. Could also give the user the option to disable this automatic checking feature at that point.

[Kunda1]

could we also offer releases somehow? Or branch selection? I would like to leave a branch of part-o-magic that works with 0.17/0.18, and continue to advance it using new stuff in 0.19 without the burden of backward compatibility.

I think you should open an FR for this in the FreeCAD-addon repo so it doesn't get lost

[yorik]

In git commit 0f714e00f1 there is now a function that you can use to check if a certain addon has an update available:

Code: Select all

def myCallbackFunction(result):
    if result == "True":
        print("A new version is available for addon XXX! Go get it!")
        # do whatever you want here, show a dialog, flash a button, etc
   else:
        print("no update available")

import AddonManager
AddonManager.check_updates("MyAddonName",myCallbackFunction)

About @TheMarkster's idea, that's what I want to do as well, but wasn't too sure of the implications of connecting and doing GIT stuff in the background while FreeCAD starts. So I implemented it locally first (in the BIM WB, and inside the AddonManager, if the appropriate option is turned on in the config screen). So far it seems to work without problems, though

[TheMarkster]

Nice.

What is the preferred way to check if this feature is available?

Code: Select all

if hasattr(AddonManager, "check_updates"):

or is there a way to check by version number? We could use the FreeCAD version information, but it could come to pass at some point AddonManager is able to update itself, which would decouple it from the FreeCAD version number.

Also, if check_updates gets expanded, perhaps to support macros from the wiki or whatever, then this above method doesn't differentiate. Is there a way to get AddonManager version number? Or would there be an even better way to check this new API for supported capabilities where we could query it with something like:

Code: Select all

if "macro_updating" in AddonManager.supported_functions():