Python plugin own settings

[digfish]

Hi everyone,
I'm new to Flow Launcher, profecient in Python programming, and I like launchers. I used in the past Launchy, Google Desktop, Keypirinha and now Flow Launcher.
I ditched Keyprinha for Flow Launcher because the latter opened me the possibility of write my own plugins in the language I'm most confortable.
My new plugin was created to allow the launch of WinSCP, a remote resource navigator, with already stored profiles. The plugin receives the location of WinSCP, reads its configuration file (.ini based) displays all the profiles found and prompts for the server you want to connect to.
Question is, I couldn't understand (yet!) how to display a setting to prompt for the location of Winscp installation folder, in the case you are, for example, using the portable version. I would like for a text box to appear in the settings panel and don't know how to that since I'm using Python. The alternative I found was to call a "Open File" dialog (using the tkinter GUI framework that comes preinstalled with Python) when you input the "trigger word" (scp) and then will show in the items, besides the stored profiles, a option to locate WinSCP's installation folder. This setting is then stored in a .ini file inside the plugin own root folder.
Is there a way to present this option in the Plugin settings panel ?

[Jack251970]

Hello, since Python plugins are JsonRPC plugin, we can only put SettingsTemplate.yaml under the plugin directory to show content in settings panel. And I can give you one example: https://github.com/Garulf/github-notifications.

[Jack251970]

Related documents are here: https://www.flowlauncher.com/docs/#/json-rpc-settings.

[digfish]

Hi,
thanks for your quick reply.
I managed to implement the settings panel for my plugin. I see a value being stored in the plugin settings folder, but I don't how do I get it :( . I don't see any method in the API :/ . https://www.flowlauncher.com/docs/#/json-rpc?id=flow-launcher-api

[Jack251970]

Hi,
thanks for your quick reply.
I managed to implement the settings panel for my plugin. I see a value being stored in the plugin settings folder, but I don't how do I get it :( . I don't see any method in the API :/ . https://www.flowlauncher.com/docs/#/json-rpc?id=flow-launcher-api

From self.settings: https://github.com/Garulf/github-notifications/blob/main/plugin%2Fmain.py#L23-L25

[cibere]

Hi, thanks for your quick reply. I managed to implement the settings panel for my plugin. I see a value being stored in the plugin settings folder, but I don't how do I get it :( . I don't see any method in the API :/ . https://www.flowlauncher.com/docs/#/json-rpc?id=flow-launcher-api

Getting your plugin's settings will change depending on what library you're using. Here is how to get the settings using the most popular libraries for the V1 API:

flox

If you're using flox, then Flox.settings can be used. Example:

class MyPlugin(Flox):
    def query(self, query):
        var = self.settings['var'] # get a setting item called 'var'

pyflowlauncher

If you're using pyflowlauncher, then Plugin.settings can be used. Example:

@plugin.on_method
def query(query: str):
    var = plugin.settings['var'] # get a setting item called 'var'

flowlauncher

If you're using flowlauncher, then you can add the following property to your subclass:

class MyPlugin(FlowLauncher):
    @property
    def settings(self):
        self.rpc_request["settings"]

then you can access the settings with MyPlugin.settings. Example:

class MyPlugin(FlowLauncher):
    @property
    def settings(self):
        self.rpc_request["settings"]

    def query(self, query):
        var = self.settings['var'] # get a setting item called 'var'

[Jack251970]

Another thing I want to let you know is that this settings panel still has some issue: #3182.

[Jack251970]

Hi, thanks for your quick reply. I managed to implement the settings panel for my plugin. I see a value being stored in the plugin settings folder, but I don't how do I get it :( . I don't see any method in the API :/ . https://www.flowlauncher.com/docs/#/json-rpc?id=flow-launcher-api

Getting your plugin's settings will change depending on what library you're using. Here is how to get the settings using the most popular libraries for the V1 API:

flox

If you're using flox, then Flox.settings can be used. Example:

class MyPlugin(Flox):
def query(self, query):
var = self.settings['var'] # get a setting item called 'var'

pyflowlauncher

If you're using pyflowlauncher, then Plugin.settings can be used. Example:

@plugin.on_method
def query(query: str):
var = plugin.settings['var'] # get a setting item called 'var'

flowlauncher

If you're using flowlauncher, then you can add the following property to your subclass:

class MyPlugin(FlowLauncher):
@Property
def settings(self):
self.rpc_request["settings"]
then you can access the settings with MyPlugin.settings. Example:

class MyPlugin(FlowLauncher):
@Property
def settings(self):
self.rpc_request["settings"]

def query(self, query):
    var = self.settings['var'] # get a setting item called 'var'

@cibere I think this is very useful, could you please create a PR to merge this to our documents? The location is here: https://github.com/Flow-Launcher/docs/blob/main/json-rpc-settings.md. Feel free to ask my review!

[digfish]

Thanks for your remarks (y) Jack Ye ***@***.***> escreveu (domingo, 9/03/2025 à(s) 05:32):

…

Hi, thanks for your quick reply. I managed to implement the settings panel for my plugin. I see a value being stored in the plugin settings folder, but I don't how do I get it :( . I don't see any method in the API :/ . https://www.flowlauncher.com/docs/#/json-rpc?id=flow-launcher-api Getting your plugin's settings will change depending on what library you're using. Here is how to get the settings using the most popular libraries for the V1 API: flox <https://github.com/garulf/flox> If you're using flox, then Flox.settings can be used. Example: class MyPlugin(Flox): def query(self, query): var = self.settings['var'] # get a setting item called 'var' pyflowlauncher <https://garulf.github.io/pyFlowLauncher/reference/plugin/#pyflowlauncher.plugin.Plugin.settings> If you're using pyflowlauncher, then Plugin.settings <https://garulf.github.io/pyFlowLauncher/reference/plugin/#pyflowlauncher.plugin.Plugin.settings> can be used. Example: @plugin.on_method def query(query: str): var = plugin.settings['var'] # get a setting item called 'var' flowlauncher <https://pypi.org/project/flowlauncher/> If you're using flowlauncher, then you can add the following property to your subclass: class MyPlugin(FlowLauncher): @Property <https://github.com/Property> def settings(self): self.rpc_request["settings"] then you can access the settings with MyPlugin.settings. Example: class MyPlugin(FlowLauncher): @Property <https://github.com/Property> def settings(self): self.rpc_request["settings"] def query(self, query): var = self.settings['var'] # get a setting item called 'var' @cibere <https://github.com/cibere> I think this is very useful, could you please create a PR to merge this to our documents? image.png (view on web) <https://github.com/user-attachments/assets/ebee1d0a-5177-48b6-a879-e4b23a00d0c9> — Reply to this email directly, view it on GitHub <#3291 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAFPCVXNCO5KN6Z6GDRHB632TPG5PAVCNFSM6AAAAABYABSFQCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDOMBYGY4DANZQGQ> . You are receiving this because you authored the thread.Message ID: ***@***.***> [image: Jack251970]*Jack251970* left a comment (Flow-Launcher/Flow.Launcher#3291) <#3291 (comment)> Hi, thanks for your quick reply. I managed to implement the settings panel for my plugin. I see a value being stored in the plugin settings folder, but I don't how do I get it :( . I don't see any method in the API :/ . https://www.flowlauncher.com/docs/#/json-rpc?id=flow-launcher-api Getting your plugin's settings will change depending on what library you're using. Here is how to get the settings using the most popular libraries for the V1 API: flox <https://github.com/garulf/flox> If you're using flox, then Flox.settings can be used. Example: class MyPlugin(Flox): def query(self, query): var = self.settings['var'] # get a setting item called 'var' pyflowlauncher <https://garulf.github.io/pyFlowLauncher/reference/plugin/#pyflowlauncher.plugin.Plugin.settings> If you're using pyflowlauncher, then Plugin.settings <https://garulf.github.io/pyFlowLauncher/reference/plugin/#pyflowlauncher.plugin.Plugin.settings> can be used. Example: @plugin.on_method def query(query: str): var = plugin.settings['var'] # get a setting item called 'var' flowlauncher <https://pypi.org/project/flowlauncher/> If you're using flowlauncher, then you can add the following property to your subclass: class MyPlugin(FlowLauncher): @Property <https://github.com/Property> def settings(self): self.rpc_request["settings"] then you can access the settings with MyPlugin.settings. Example: class MyPlugin(FlowLauncher): @Property <https://github.com/Property> def settings(self): self.rpc_request["settings"] def query(self, query): var = self.settings['var'] # get a setting item called 'var' @cibere <https://github.com/cibere> I think this is very useful, could you please create a PR to merge this to our documents? image.png (view on web) <https://github.com/user-attachments/assets/ebee1d0a-5177-48b6-a879-e4b23a00d0c9> — Reply to this email directly, view it on GitHub <#3291 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAFPCVXNCO5KN6Z6GDRHB632TPG5PAVCNFSM6AAAAABYABSFQCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDOMBYGY4DANZQGQ> . You are receiving this because you authored the thread.Message ID: ***@***.***>

[cibere]

@cibere I think this is very useful, could you please create a PR to merge this to our documents? The location is here: https://github.com/Flow-Launcher/docs/blob/main/json-rpc-settings.md. Feel free to ask my review!

@Jack251970 tbf the docs in general are heavily lacking and need an overhaul, however this is something that I don't believe should be included in the docs.

The python package that flow provides and that the docs show you how to use doesn't natively support getting plugin settings, which I assume is why getting them isn't mentioned in the docs.

If I were to PR something, I would want to properly support getting settings with the flowlauncher library, and document it as such. However as for the other libraries, I feel like it should be up to them to document how to do it.