Merge branch 'plugin_api_v2' into add_virus_toal_scan

Author: jjw24

.github/workflows/links.yml

@@ -30,4 +30,5 @@ jobs:
         with:
           args: --verbose --no-progress plugins.json
           fail: true
+          failIfEmpty: false
           token: ${{ secrets.LINKCHECKER }}

.github/workflows/python-passed.yml

@@ -19,8 +19,12 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: 3.x
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r ./ci/envs/requirements-update-tested.txt
       - name: Run script
-        run: python ./ci/src/update-tested.py
+        run: python ./ci/src/update-tested.py ${{ secrets.DISCORD_WEBHOOK }}
       - name: Update plugin manifest
         if: success()
         uses: stefanzweifel/git-auto-commit-action@v4

.github/workflows/test-python.yml

@@ -47,7 +47,7 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: ${{ github.event.inputs.pyversion }}
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         if: startsWith(runner.os, 'Windows')
         with:
           path: ~\AppData\Local\pip\Cache

.github/workflows/website-deploy.yml

@@ -0,0 +1,22 @@
+name: Deploy Website
+
+on:
+  push:
+    branches: [ plugin_api_v2 ]
+    paths:
+      - 'plugins.json'
+  workflow_dispatch:
+
+jobs:
+  dispatch:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Dispatch event
+        run: |
+          http_status=$(curl -L -f -s -o /dev/null -w "%{http_code}" \
+            -X POST \
+            -H "Accept: application/vnd.github+json" \
+            -H "Authorization: Bearer ${{ secrets.DEPLOY_WEBSITE }}" \
+            https://api.github.com/repos/Flow-Launcher/flow-launcher.github.io/dispatches \
+            -d '{"event_type":"deploy"}')
+          if [ "$http_status" -ne 204 ]; then echo "Error: Deploy trigger failed, HTTP status code is $http_status"; exit 1; fi

README.md

@@ -6,12 +6,12 @@ This repository contains the information for community-made plugins used in [Flo
 
 ## Plugin list
 
-Looking for a list of currently available plugins in Flow? Visit [here](https://flow-launcher.github.io/docs/#/plugins)
+Looking for a list of currently available plugins in Flow? Visit [here](https://www.flowlauncher.com/plugins)
 
 ## How to submit your plugin
 
-1. Create a file named `${name}-${uuid}.json` in the _plugins_ directory.
-2. Copy these items from your plugin project's plugin.json file:
+1. Create a file named `${name}-${uuid}.json` in the [plugins](https://github.com/Flow-Launcher/Flow.Launcher.PluginsManifest/tree/plugin_api_v2/plugins) directory.
+2. Copy these items from your plugin project's `plugin.json` file:
    - `ID`
    - `Name`
    - `Description`
@@ -23,16 +23,16 @@ Looking for a list of currently available plugins in Flow? Visit [here](https://
 4. It should look like this:
    ```json
    {
-     "ID": "Unique GUID from your plugin.json",  
-     "Name": "Plugin name",
-     "Description": "Short description",
-     "Author": "Author",
-     "Version": "Version from your plugin.json",
-     "Language": "Programming language",
-     "Website": "Plugin website",
-     "UrlDownload": "URL to download",
-     "UrlSourceCode": "URL to source code",
-     "IcoPath": "Plugin icon image's CDN URL, e.g. https://cdn.jsdelivr.net/gh/Flow-Launcher/Flow.Launcher/Plugins/Flow.Launcher.Plugin.Explorer/Images/explorer.png"
+     "ID": "Unique GUID from your plugin.json, e.g. 2f4e384e-76ce-45c3-aea2-b16f5e5c328f",
+     "Name": "Plugin name, e.g. Hello World Python",
+     "Description": "Short description, e.g. Python Hello World example plugin",
+     "Author": "Author, e.g. Flow Launcher",
+     "Version": "Version from your plugin.json, e.g. 1.0.0",
+     "Language": "Programming language, e.g. python",
+     "Website": "Plugin website, e.g. https://github.com/Flow-Launcher/Flow.Launcher.Plugin.HelloWorldPython",
+     "UrlDownload": "URL to download, e.g. https://github.com/Flow-Launcher/Flow.Launcher.Plugin.HelloWorldPython/releases/download/v1.0.0/Flow.Launcher.Plugin.HelloWorldPython.zip",
+     "UrlSourceCode": "URL to source code, e.g. https://github.com/Flow-Launcher/Flow.Launcher.Plugin.HelloWorldPython/tree/main", 
+     "IcoPath": "Plugin icon image's CDN URL, e.g. https://cdn.jsdelivr.net/gh/Flow-Launcher/Flow.Launcher.Plugin.HelloWorldPython@main/Images/app.png"
    }
    ```
 5. For `IcoPath`, use a CDN provider for global accessibility. [jsdelivr.com](https://www.jsdelivr.com/) for example as shown above, works well with GitHub repositories.
@@ -49,6 +49,8 @@ While the plugin has not yet appeared in the store, you and your users can manua
 
 Every three hours the *CI* in this repository will check for new updates from plugins and automatically update them to the latest version.
 
+So you do not need to manually submit a pull request after you make a new release.
+
 ## Plugin Store policy
 
 Plugins that facilitate or contain any of the following will not be allowed:
@@ -65,7 +67,7 @@ Plugins that facilitate or contain any of the following will not be allowed:
 ## Plugin Store
 
 Users will be able to install your plugin via the store or type `pm install <your-plugin-name>`:
-<p align="center"><img src="https://user-images.githubusercontent.com/6903107/207155616-d559f0d2-ee95-4072-a7bc-3ffcc2faec27.png" width="800"></p>
+<p align="center"><img src="assets/plugin_store.png" width="800"></p>
 
 ## Have a plugin enhancement request or issue?
 

assets/plugin_store.png

@@ -0,0 +1,2 @@
+aiohttp
+tqdm

ci/envs/requirements-update-tested.txt

@@ -8,6 +8,10 @@
 # If adding a third-party library here, check CI workflows Python files
 # that are dependant on this and require pip install.
 
+github_download_url_regex = re.compile(
+    r"https://github\.com/(?P<author>[a-zA-Z0-9-]+)/(?P<repo>[a-zA-Z0-9\.\-\_]*)/releases/download/(?P<version>[a-zA-Z\.0-9]+)/(?P<filename>.*)\.zip"
+)
+
 # path
 utils_path = Path(__file__).resolve()
 
@@ -44,6 +48,7 @@
 github_url = "https://github.com"
 release_date = "LatestReleaseDate"
 date_added = "DateAdded"
+website = "Website"
 
 # typing
 PluginType = Dict[str, str]

ci/src/_utils.py

@@ -1,11 +1,11 @@
 import aiohttp
-
+from tqdm.asyncio import tqdm
 from _utils import *
 
 MAX_BODY_LEN = 1024
 
 
-async def update_hook(webhook_url: str, info: dict, latest_ver: str, release: dict) -> None:
+async def update_hook(webhook_url: str, info: PluginType, latest_ver: str, release: dict) -> None:
     embed = {
         "content": None,
         "embeds": [
@@ -43,6 +43,43 @@ async def update_hook(webhook_url: str, info: dict, latest_ver: str, release: di
         embed['embeds'][0]['fields'].append({"name": "Release Notes", "value": truncate_release_notes(release['html_url'], release.get('body', ""))})
     async with aiohttp.ClientSession() as session:
         await session.post(webhook_url, json=embed)
+
+async def release_hook(webhook_url: str, info: PluginType) -> None:
+    embed = {
+        "content": None,
+        "embeds": [
+            {
+            "title": info[plugin_name],
+            "description": f"New Plugin!\nReleased at v{info[version]}.",
+            "url": info[website],
+            "color": 5763719, # green
+            "fields": [
+                {
+                "name": "Plugin Description",
+                "value": info[description]
+                },
+                {
+                "name": "Plugin Language",
+                "value": info[language_name]
+                }
+            ],
+            "author": {
+                "name": info[author]
+            },
+            "thumbnail": {
+                "url": info[icon_path]
+            }
+            }
+        ]
+        }
+    if 'github.com' in info[url_sourcecode].lower():
+        github_username = info[url_sourcecode].split('/')[3]
+        embed['embeds'][0]['author']['name'] = github_username
+        embed['embeds'][0]['author']['url'] = f"{github_url}/{github_username}"
+        embed['embeds'][0]["author"]["icon_url"] = f"{github_url}/{github_username}.png?size=40"
+    
+    async with aiohttp.ClientSession() as session:
+        await session.post(webhook_url, json=embed)
 
 def truncate_release_notes(url: str, release_notes: str, length: int = MAX_BODY_LEN) -> str:
     if len(release_notes) <= length:

ci/src/discord.py

@@ -81,15 +81,36 @@ def get_all_python_plugins(manifest: dict) -> list:
     return [plugin for plugin in manifest if plugin["Language"].lower() == "python"]
 
 def run_plugin(plugin_name: str, plugin_path: str, execute_path: str) -> bool:
-    """Run plugin and check output. Returns true if test successfull else false"""
+    """Run plugin and check output. Returns true if test successful else false"""
     os.chdir(plugin_path)
     default_settings = init_settings(plugin_name, plugin_path)
     args = json.dumps(
         {"method": "query", "parameters": [""], "Settings": default_settings}
     )
-    full_args = ["python", "-S", Path(plugin_path, execute_path), args]
+
     # Older Flox used environmental variable to locate Images directory
     os.environ["PYTHONPATH"] = str(USER_PATH.joinpath("PythonEmbeddable"))
+
+    # Compose the sys.path setup and runpy logic as Flow Launcher does in
+    # https://github.com/Flow-Launcher/Flow.Launcher/blob/dfe96160ed44684810bcdf853f86fda4305122d6/Flow.Launcher.Core/Plugin/PythonPlugin.cs#L69-L81
+    sys_path_setup = (
+        f"import sys; "
+        f"sys.path.append(r'{plugin_path}'); "
+        f"sys.path.append(r'{plugin_path}\\lib'); "
+        f"sys.path.append(r'{plugin_path}\\lib\\win32\\lib'); "
+        f"sys.path.append(r'{plugin_path}\\lib\\win32'); "
+        f"sys.path.append(r'{plugin_path}\\plugin'); "
+        f"import runpy; "
+        f"runpy.run_path(r'{Path(plugin_path, execute_path)}', None, '__main__')"
+    )
+    
+    full_args = [
+        "python",
+        "-S",
+        "-c",
+        sys_path_setup,
+        args
+    ]
     print_section("Input", full_args)
     p = Popen(full_args, text=True, stdout=PIPE, stderr=PIPE)
     stdout, stderr = p.communicate()
@@ -104,7 +125,7 @@ def run_plugin(plugin_name: str, plugin_path: str, execute_path: str) -> bool:
         return True
     else:
         print_section(f"{plugin['Name']} test FAILED!", "")
-        print(f'Plugin returned a non-zero exit code: {max(exit_code, 1)}')
+        print(f'Plugin has returned a non-zero exit code: {max(exit_code, 1)}')
         if stderr != "":
             print_section('Trace', stderr)
         if json_msg: