pyflowlauncher 0.2.0.dev1__tar.gz → 0.3.0.dev1__tar.gz

{pyflowlauncher-0.2.0.dev1 → pyflowlauncher-0.3.0.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyflowlauncher
-Version: 0.2.0.dev1
+Version: 0.3.0.dev1
 Summary: Python library to help build Flow Launcher plugins.
 Author-email: William McAllister <dev.garulf@gmail.com>
 License: MIT
@@ -26,7 +26,7 @@ A basic plugin using a function as the query method.
 
 ```py
 from pyflowlauncher import Plugin, Result, send_results
-from pyflowlauncher.result import, ResultResponse
+from pyflowlauncher.result import ResultResponse
 
 plugin = Plugin()
 
@@ -50,7 +50,7 @@ A more advanced usage using a `Method` class as the query method.
 
 ```py
 from pyflowlauncher import Plugin, Result, Method
-from pyflowlauncher.result import, ResultResponse
+from pyflowlauncher.result import ResultResponse
 
 plugin = Plugin()
 

{pyflowlauncher-0.2.0.dev1 → pyflowlauncher-0.3.0.dev1}/README.md

@@ -14,7 +14,7 @@ A basic plugin using a function as the query method.
 
 ```py
 from pyflowlauncher import Plugin, Result, send_results
-from pyflowlauncher.result import, ResultResponse
+from pyflowlauncher.result import ResultResponse
 
 plugin = Plugin()
 
@@ -38,7 +38,7 @@ A more advanced usage using a `Method` class as the query method.
 
 ```py
 from pyflowlauncher import Plugin, Result, Method
-from pyflowlauncher.result import, ResultResponse
+from pyflowlauncher.result import ResultResponse
 
 plugin = Plugin()
 

{pyflowlauncher-0.2.0.dev1 → pyflowlauncher-0.3.0.dev1}/pyflowlauncher/__init__.py

@@ -2,8 +2,9 @@ import importlib.metadata
 import logging
 import os
 
-from .plugin import Plugin, ResultResponse
-from .result import JsonRPCAction, Result, send_results
+from .plugin import Plugin
+from .result import JsonRPCAction, Result, send_results, ResultResponse
+from .method import Method
 
 log_level = os.environ.get("FLOW_LAUNCHER_API_LOG_LEVEL", "INFO")
 
@@ -19,6 +20,7 @@ __all__ = [
     "send_results",
     "Result",
     "JsonRPCAction",
+    "Method",
 ]
 
 

pyflowlauncher-0.3.0.dev1/pyflowlauncher/manifest.py

@@ -0,0 +1,25 @@
+from typing import TypedDict, Literal
+
+MANIFEST_FILE = 'plugin.json'
+
+Languages = Literal[
+    'Python',
+    'CSharp',
+    'FSharp',
+    'Executable',
+    'TypeScript',
+    'JavaScript',
+]
+
+
+class PluginManifestSchema(TypedDict):
+    ID: str
+    ActionKeyword: str
+    Name: str
+    Description: str
+    Author: str
+    Version: str
+    Language: Languages
+    Website: str
+    IcoPath: str
+    ExecuteFileName: str

{pyflowlauncher-0.2.0.dev1 → pyflowlauncher-0.3.0.dev1}/pyflowlauncher/plugin.py

@@ -1,13 +1,17 @@
 from __future__ import annotations
 
+import sys
 from functools import wraps
 from typing import Any, Callable, Iterable, Union
+from pathlib import Path
+import json
 
 from pyflowlauncher.shared import logger
 
 from .event import EventHandler
 from .jsonrpc import JsonRPCClient
 from .result import JsonRPCAction, ResultResponse
+from .manifest import PluginManifestSchema, MANIFEST_FILE
 
 Method = Callable[..., Union[ResultResponse, JsonRPCAction]]
 
@@ -54,3 +58,13 @@ class Plugin:
         if 'result' in feedback and self._settings is not None:
             feedback['SettingsChange'] = self.settings
         self._client.send(feedback)
+
+    def plugin_root_dir(self) -> Path:
+        """Return the root directory of the plugin."""
+        return Path(sys.argv[0]).parent
+
+    def manifest(self) -> PluginManifestSchema:
+        """Return the plugin manifest."""
+        with open(self.plugin_root_dir() / MANIFEST_FILE, 'r', encoding='utf-8') as f:
+            manifest = json.load(f)
+        return manifest

{pyflowlauncher-0.2.0.dev1 → pyflowlauncher-0.3.0.dev1}/pyflowlauncher.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyflowlauncher
-Version: 0.2.0.dev1
+Version: 0.3.0.dev1
 Summary: Python library to help build Flow Launcher plugins.
 Author-email: William McAllister <dev.garulf@gmail.com>
 License: MIT
@@ -26,7 +26,7 @@ A basic plugin using a function as the query method.
 
 ```py
 from pyflowlauncher import Plugin, Result, send_results
-from pyflowlauncher.result import, ResultResponse
+from pyflowlauncher.result import ResultResponse
 
 plugin = Plugin()
 
@@ -50,7 +50,7 @@ A more advanced usage using a `Method` class as the query method.
 
 ```py
 from pyflowlauncher import Plugin, Result, Method
-from pyflowlauncher.result import, ResultResponse
+from pyflowlauncher.result import ResultResponse
 
 plugin = Plugin()
 

{pyflowlauncher-0.2.0.dev1 → pyflowlauncher-0.3.0.dev1}/pyflowlauncher.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ pyflowlauncher/api.py
 pyflowlauncher/event.py
 pyflowlauncher/icons.py
 pyflowlauncher/jsonrpc.py
+pyflowlauncher/manifest.py
 pyflowlauncher/method.py
 pyflowlauncher/plugin.py
 pyflowlauncher/result.py

{pyflowlauncher-0.2.0.dev1 → pyflowlauncher-0.3.0.dev1}/pyproject.toml

@@ -6,7 +6,7 @@ name = "pyflowlauncher"
 authors = [
     {name = "William McAllister", email = "dev.garulf@gmail.com"}
 ]
-version = '0.2.0-dev.1'
+version = '0.3.0-dev.1'
 description = "Python library to help build Flow Launcher plugins."
 readme = "README.md"
 requires-python = ">=3.8"
@@ -24,7 +24,7 @@ dependencies = [
 packages = ["pyflowlauncher"]
 
 [tool.bumpversion]
-current_version = "0.2.0-dev.1"
+current_version = "0.3.0-dev.1"
 parse = """(?x)
     (?P<major>[0-9]+)
     \\.(?P<minor>[0-9]+)