Python SDK Reference

Detailed reference for the addon_update_checker module API.

Functions

register(**kwargs)

Registers the update checker. Must be called in your addon's register() function, ideally at the end.

addon_update_checker.register(
    parent_addon_name=__name__,  # Optional: Override parent package name
    addon_id="custom-id",        # Optional: Override manifest ID
    use_community=True           # Optional: Enable community database fallback
)

Parameters

• parent_addon_name (str, optional): Override the parent package name detection.
• addon_id (str, optional): Override the add-on ID from manifest.
• use_community (bool, optional, default=False): If True, falls back to the community-driven version database when the add-on is not officially registered. This allows your users to benefit from crowd-sourced version tracking.

unregister()

Unregisters the update checker. Must be called in your addon's unregister() function, ideally at the beginning.

draw_update_section_for_prefs(layout, context)

Draws the update notification UI, settings, and check buttons within a simplified layout suitable for Preferences.

draw_update_section_for_panel(layout, context)

Draws a compact checking/notification UI suitable for sidebars (N-Panel).

Classes

AddonUpdateCheckerProperties

A property group mixin that adds update-checker specific properties to your Preferences class.

class MyPreferences(bpy.types.AddonPreferences,
                    addon_update_checker.AddonUpdateCheckerProperties):
    # ...

Injected Properties:

• auc_use_gizmo_notifications (Bool): Controls if viewport overlays are enabled.

State Access

You can access the internal state to build custom UIs:

data = addon_update_checker._state.get_update_info()
# Returns dict:
# {
#   "update_available": bool,
#   "latest_version": str,
#   "update_url": str,
#   ...
# }