wox-plugin 0.0.1__tar.gz

wox_plugin-0.0.1/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.1
+Name: wox-plugin
+Version: 0.0.1
+Summary: All Python plugins for Wox should use types in this package
+Home-page: https://github.com/Wox-launcher/Wox
+Author: Wox-launcher
+Author-email: 
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8

wox_plugin-0.0.1/README.md

@@ -0,0 +1 @@
+ 

wox_plugin-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

wox_plugin-0.0.1/setup.py

@@ -0,0 +1,23 @@
+from setuptools import setup, find_packages
+
+setup(
+    name="wox-plugin",
+    version="0.0.1",
+    description="All Python plugins for Wox should use types in this package",
+    author="Wox-launcher",
+    author_email="",
+    url="https://github.com/Wox-launcher/Wox",
+    packages=find_packages(),
+    install_requires=[],
+    python_requires=">=3.8",
+    classifiers=[
+        "Development Status :: 3 - Alpha",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+    ],
+)

wox_plugin-0.0.1/wox_plugin/__init__.py

@@ -0,0 +1,55 @@
+from .types import (
+    # Basic types
+    MapString,
+    Platform,
+    
+    # Context
+    Context,
+    new_context,
+    new_context_with_value,
+    
+    # Selection
+    SelectionType,
+    Selection,
+    
+    # Query
+    QueryType,
+    Query,
+    QueryEnv,
+    
+    # Result
+    WoxImageType,
+    WoxImage,
+    new_base64_wox_image,
+    WoxPreviewType,
+    WoxPreview,
+    ResultTailType,
+    ResultTail,
+    ActionContext,
+    ResultAction,
+    Result,
+    RefreshableResult,
+    
+    # Plugin API
+    ChangeQueryParam,
+    
+    # AI
+    ConversationRole,
+    ChatStreamDataType,
+    Conversation,
+    ChatStreamFunc,
+    
+    # Settings
+    PluginSettingDefinitionType,
+    PluginSettingValueStyle,
+    PluginSettingDefinitionValue,
+    PluginSettingDefinitionItem,
+    MetadataCommand,
+    
+    # Plugin Interface
+    Plugin,
+    PublicAPI,
+    PluginInitParams,
+)
+
+__version__ = "0.0.82" 

wox_plugin-0.0.1/wox_plugin/types.py

@@ -0,0 +1,261 @@
+from dataclasses import dataclass
+from enum import Enum
+from typing import Dict, List, Optional, Protocol, Union, Callable, Any, TypedDict, Literal
+import uuid
+
+# Basic types
+MapString = Dict[str, str]
+Platform = Literal["windows", "darwin", "linux"]
+
+# Context
+class Context(TypedDict):
+    Values: Dict[str, str]
+
+def new_context() -> Context:
+    return {"Values": {"traceId": str(uuid.uuid4())}}
+
+def new_context_with_value(key: str, value: str) -> Context:
+    ctx = new_context()
+    ctx["Values"][key] = value
+    return ctx
+
+# Selection
+class SelectionType(str, Enum):
+    TEXT = "text"
+    FILE = "file"
+
+@dataclass
+class Selection:
+    Type: SelectionType
+    Text: Optional[str] = None
+    FilePaths: Optional[List[str]] = None
+
+# Query Environment
+@dataclass
+class QueryEnv:
+    ActiveWindowTitle: str
+
+# Query
+class QueryType(str, Enum):
+    INPUT = "input"
+    SELECTION = "selection"
+
+@dataclass
+class Query:
+    Type: QueryType
+    RawQuery: str
+    TriggerKeyword: Optional[str]
+    Command: Optional[str]
+    Search: str
+    Selection: Selection
+    Env: QueryEnv
+
+    def is_global_query(self) -> bool:
+        return self.Type == QueryType.INPUT and not self.TriggerKeyword
+
+# Result
+class WoxImageType(str, Enum):
+    ABSOLUTE = "absolute"
+    RELATIVE = "relative"
+    BASE64 = "base64"
+    SVG = "svg"
+    URL = "url"
+    EMOJI = "emoji"
+    LOTTIE = "lottie"
+
+@dataclass
+class WoxImage:
+    ImageType: WoxImageType
+    ImageData: str
+
+def new_base64_wox_image(image_data: str) -> WoxImage:
+    return WoxImage(ImageType=WoxImageType.BASE64, ImageData=image_data)
+
+class WoxPreviewType(str, Enum):
+    MARKDOWN = "markdown"
+    TEXT = "text"
+    IMAGE = "image"
+    URL = "url"
+    FILE = "file"
+
+@dataclass
+class WoxPreview:
+    PreviewType: WoxPreviewType
+    PreviewData: str
+    PreviewProperties: Dict[str, str]
+
+class ResultTailType(str, Enum):
+    TEXT = "text"
+    IMAGE = "image"
+
+@dataclass
+class ResultTail:
+    Type: ResultTailType
+    Text: Optional[str] = None
+    Image: Optional[WoxImage] = None
+
+@dataclass
+class ActionContext:
+    ContextData: str
+
+@dataclass
+class ResultAction:
+    Id: Optional[str]
+    Name: str
+    Icon: Optional[WoxImage]
+    IsDefault: Optional[bool]
+    PreventHideAfterAction: Optional[bool]
+    Action: Callable[[ActionContext], None]
+    Hotkey: Optional[str]
+
+@dataclass
+class Result:
+    Id: Optional[str]
+    Title: str
+    SubTitle: Optional[str]
+    Icon: WoxImage
+    Preview: Optional[WoxPreview]
+    Score: Optional[float]
+    Group: Optional[str]
+    GroupScore: Optional[float]
+    Tails: Optional[List[ResultTail]]
+    ContextData: Optional[str]
+    Actions: Optional[List[ResultAction]]
+    RefreshInterval: Optional[int]
+    OnRefresh: Optional[Callable[["RefreshableResult"], "RefreshableResult"]]
+
+@dataclass
+class RefreshableResult:
+    Title: str
+    SubTitle: str
+    Icon: WoxImage
+    Preview: WoxPreview
+    Tails: List[ResultTail]
+    ContextData: str
+    RefreshInterval: int
+    Actions: List[ResultAction]
+
+# Plugin API
+@dataclass
+class ChangeQueryParam:
+    QueryType: QueryType
+    QueryText: Optional[str]
+    QuerySelection: Optional[Selection]
+
+# AI
+class ConversationRole(str, Enum):
+    USER = "user"
+    SYSTEM = "system"
+
+class ChatStreamDataType(str, Enum):
+    STREAMING = "streaming"
+    FINISHED = "finished"
+    ERROR = "error"
+
+@dataclass
+class Conversation:
+    Role: ConversationRole
+    Text: str
+    Timestamp: int
+
+ChatStreamFunc = Callable[[ChatStreamDataType, str], None]
+
+# Settings
+class PluginSettingDefinitionType(str, Enum):
+    HEAD = "head"
+    TEXTBOX = "textbox"
+    CHECKBOX = "checkbox"
+    SELECT = "select"
+    LABEL = "label"
+    NEWLINE = "newline"
+    TABLE = "table"
+    DYNAMIC = "dynamic"
+
+@dataclass
+class PluginSettingValueStyle:
+    PaddingLeft: int
+    PaddingTop: int
+    PaddingRight: int
+    PaddingBottom: int
+    Width: int
+    LabelWidth: int
+
+@dataclass
+class PluginSettingDefinitionValue:
+    def get_key(self) -> str:
+        raise NotImplementedError
+
+    def get_default_value(self) -> str:
+        raise NotImplementedError
+
+    def translate(self, translator: Callable[[Context, str], str]) -> None:
+        raise NotImplementedError
+
+@dataclass
+class PluginSettingDefinitionItem:
+    Type: PluginSettingDefinitionType
+    Value: PluginSettingDefinitionValue
+    DisabledInPlatforms: List[Platform]
+    IsPlatformSpecific: bool
+
+@dataclass
+class MetadataCommand:
+    Command: str
+    Description: str
+
+# Plugin Interface
+class Plugin(Protocol):
+    async def init(self, ctx: Context, init_params: "PluginInitParams") -> None:
+        ...
+
+    async def query(self, ctx: Context, query: Query) -> List[Result]:
+        ...
+
+# Public API Interface
+class PublicAPI(Protocol):
+    async def change_query(self, ctx: Context, query: ChangeQueryParam) -> None:
+        ...
+
+    async def hide_app(self, ctx: Context) -> None:
+        ...
+
+    async def show_app(self, ctx: Context) -> None:
+        ...
+
+    async def notify(self, ctx: Context, message: str) -> None:
+        ...
+
+    async def log(self, ctx: Context, level: str, msg: str) -> None:
+        ...
+
+    async def get_translation(self, ctx: Context, key: str) -> str:
+        ...
+
+    async def get_setting(self, ctx: Context, key: str) -> str:
+        ...
+
+    async def save_setting(self, ctx: Context, key: str, value: str, is_platform_specific: bool) -> None:
+        ...
+
+    async def on_setting_changed(self, ctx: Context, callback: Callable[[str, str], None]) -> None:
+        ...
+
+    async def on_get_dynamic_setting(self, ctx: Context, callback: Callable[[str], PluginSettingDefinitionItem]) -> None:
+        ...
+
+    async def on_deep_link(self, ctx: Context, callback: Callable[[MapString], None]) -> None:
+        ...
+
+    async def on_unload(self, ctx: Context, callback: Callable[[], None]) -> None:
+        ...
+
+    async def register_query_commands(self, ctx: Context, commands: List[MetadataCommand]) -> None:
+        ...
+
+    async def llm_stream(self, ctx: Context, conversations: List[Conversation], callback: ChatStreamFunc) -> None:
+        ...
+
+@dataclass
+class PluginInitParams:
+    API: PublicAPI
+    PluginDirectory: str 

wox_plugin-0.0.1/wox_plugin.egg-info/PKG-INFO

@@ -0,0 +1,16 @@
+Metadata-Version: 2.1
+Name: wox-plugin
+Version: 0.0.1
+Summary: All Python plugins for Wox should use types in this package
+Home-page: https://github.com/Wox-launcher/Wox
+Author: Wox-launcher
+Author-email: 
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.8

wox_plugin-0.0.1/wox_plugin.egg-info/SOURCES.txt

@@ -0,0 +1,8 @@
+README.md
+setup.py
+wox_plugin/__init__.py
+wox_plugin/types.py
+wox_plugin.egg-info/PKG-INFO
+wox_plugin.egg-info/SOURCES.txt
+wox_plugin.egg-info/dependency_links.txt
+wox_plugin.egg-info/top_level.txt

wox_plugin-0.0.1/wox_plugin.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

wox_plugin-0.0.1/wox_plugin.egg-info/top_level.txt

@@ -0,0 +1 @@
+wox_plugin