erpdesktop 1.0.0

ERPDesktop plugin SDK — build, package, and publish plugins for the ERPDesktop marketplace

ERPDesktop Plugin SDK

Build, package, and publish plugins for the ERPDesktop marketplace.

Install

pip install erpdesktop-sdk

Quick start

# Scaffold a new plugin
erpdesktop init my-plugin

# Validate your plugin.json
erpdesktop validate

# Package into a distributable .zip
erpdesktop package

# Publish to the marketplace
erpdesktop publish --changelog "Initial release"

PluginBase lifecycle

from erpdesktop import PluginBase, log, event

class MyPlugin(PluginBase):
    plugin_id = "com.example.my-plugin"
    plugin_version = "1.0.0"

    def on_start(self, config):
        log("info", "Started", branch=config.get("branch"))
        self.register_command("ping", lambda p: {"pong": True})

    def on_stop(self):
        log("info", "Shutting down")

if __name__ == "__main__":
    MyPlugin().run()

Commands

Command	Description
erpdesktop init <name>	Scaffold a new plugin
erpdesktop validate	Validate plugin.json
erpdesktop package	Create .zip distributable
erpdesktop publish	Upload to marketplace
erpdesktop --version	Show SDK version