Refactor plugin structure and update build workflow

Moved image assets to the 'assets' directory and updated references. Deleted Plugin/core.py and generate_plugin_file.py, consolidating plugin logic into main.py. Improved main.py to handle plugin initialization and notification, with logging for disabled state. Updated plugin.json metadata and version. Replaced custom build steps in GitHub Actions with FlowBuildPluginAction, and added pyproject.toml for linting and type checking configuration. Added aioconsole to requirements.txt.

Author: cibere

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -41,15 +41,11 @@ body:
   - type: textarea
     attributes:
       label: Flow Launcher Log File
-      description: Use the `Open Log Location` command with the `System Commands` plugin to open the log file folder, and upload the newest file here.
-    validations:
-      required: true
+      description: If applicable, use the `Open Log Location` command with the `System Commands` plugin to open the log file folder, and upload the newest file here.
   - type: textarea
     attributes:
       label: Flogin Log File
-      description: Use the `Flow Launcher UserData Folder` command with the `System Commands` plugin to open your userdata folder, go into the `Plugins` folder, then find the plugin and go into it. If the `flogin.log` file exists, upload it here. Otherwise please state that it was not there.
-    validations:
-      required: true
+      description: If applicable, use the `Flow Launcher UserData Folder` command with the `System Commands` plugin to open your userdata folder, go into the `Plugins` folder, then find the plugin and go into it. If the `flogin.log` file exists, upload it here. Otherwise please state that it was not there.
   - type: checkboxes
     attributes:
       label: Checklist
@@ -58,7 +54,7 @@ body:
       options:
         - label: I have searched the open issues for duplicates.
           required: true
-        - label: I have shown the entire traceback, if possible.
+        - label: I have shown all applicable log files.
           required: true
   - type: textarea
     attributes:

.github/workflows/build.yml

@@ -1,52 +1,24 @@
-# This is a basic workflow that is manually triggered
+name: Build Plugin
 
-name: Build and Release
-
-# Controls when the action will run. Workflow runs when manually triggered using the UI
-# or API.
 on:
-  workflow_dispatch:
+    push:
+        branches: [master]
+    release:
+        types: [published]
+    workflow_dispatch:
 
 jobs:
-  publish:
+  build:
     runs-on: ubuntu-latest
     env:
-      python_ver: 3.12
+      python_ver: 3.11.4
     permissions:
       contents: write
 
     steps:
-      - uses: actions/checkout@v2
-
-      - name: Set up Python ${{ env.python_ver }}
-        uses: actions/setup-python@v2
-        with:
-          python-version: ${{ env.python_ver }}
-    
-      - name: Run generator file
-        run: python generate_plugin_file.py
-
-      - name: get version
-        id: version
-        uses: notiz-dev/github-action-json-property@release
-        with: 
-          path: 'plugin.json'
-          prop_path: 'Version'
-
-      - run: echo ${{steps.version.outputs.prop}} 
-
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          pip install -r ./requirements.txt -t ./lib
-
-      - name: Package to zip
-        run: zip -r Flow.Launcher.Plugin.FlowLoadNotification.zip . -x '*.git*'
-
-      - name: Publish
-        if: success()
-        uses: softprops/action-gh-release@v2
+      - uses: actions/checkout@v4
+      - uses: cibere/FlowBuildPluginAction@master
         with:
-          files: 'Flow.Launcher.Plugin.FlowLoadNotification.zip'
-          tag_name: "v${{steps.version.outputs.prop}}"
-          body_path: 'CHANGELOG.txt'
+          discord_webhook_url: ${{ secrets.DISCORD_BUILD_WEBHOOK }}
+          dirs: assets
+          files: main.py

Plugin/core.py

@@ -4,9 +4,32 @@
 parent_folder_path = os.path.abspath(os.path.dirname(__file__))
 sys.path.append(parent_folder_path)
 sys.path.append(os.path.join(parent_folder_path, "lib"))
-sys.path.append(os.path.join(parent_folder_path, "plugin"))
+sys.path.append(os.path.join(parent_folder_path, ".venv", "lib", "site-packages"))
 
-from Plugin.core import plugin
+import logging
 
-if __name__ == "__main__":
-    plugin.run()
+from flogin import Plugin
+
+log = logging.getLogger("plugin")
+
+plugin = Plugin()
+
+
+@plugin.event
+async def on_initialization() -> None:
+    for keyword in plugin.metadata.keywords:
+        await plugin.metadata.remove_keyword(keyword)
+
+    if plugin.metadata.disabled:
+        log.info("plugin disabled, not sending notification")
+    else:
+        await plugin.api.show_notification(
+            "Flow Load Notification",
+            "Flow Load Notification has loaded. Flow Launcher should finish loading monetarily.",
+        )
+        log.info("Notification sent")
+
+    sys.exit()
+
+
+plugin.run()

Images/app.png assets/app.pngImages/app.png renamed to assets/app.png

@@ -1,12 +1,12 @@
 {
-    "ID": "f628943c-5c77-4b30-ab4a-6155c8fff1ec",
+    "ID": "5f48576d-efe7-4562-a4ed-fe64455f1ac1",
     "ActionKeyword": "flow-load-notification",
-    "Name": "Dev - Flow Load Notification",
+    "Name": "Flow Load Notification",
     "Description": "A plugin that only sends a notification when the plugin gets loaded after a restart or on first start.",
     "Author": "cibere",
-    "Version": "0.0.4",
+    "Version": "0.0.5",
     "Language": "python_v2",
     "Website": "https://github.com/cibere/Flow.Launcher.Plugin.FlowLoadNotification",
-    "IcoPath": "Images\\app.png",
+    "IcoPath": "assets\\app.png",
     "ExecuteFileName": "main.py"
 }

Images/example.png assets/example.pngImages/example.png renamed to assets/example.png

@@ -0,0 +1,65 @@
+# [tool.pytest.ini_options]
+# asyncio_default_fixture_loop_scope = "module"
+# addopts = "--cov=flogin --cov-report term-missing --cov-report html"
+#
+# [tool.coverage.report]
+# exclude_also = [
+#     "def __repr__",
+#     "raise AssertionError",
+#     "raise NotImplementedError",
+#     "if 0:",
+#     "if __name__ == .__main__.:",
+#     "if TYPE_CHECKING:",
+#     "class .*\\bProtocol\\):",
+#     "@(abc\\.)?abstractmethod",
+#     "# cov: skip"
+# ]
+
+# [tool.ruff]
+# exclude = []
+
+[tool.ruff.lint]
+select = [
+    "C4", # https://docs.astral.sh/ruff/rules/#flake8-comprehensions-c4
+    "E",  # https://docs.astral.sh/ruff/rules/#error-e_1
+    "F",  # https://docs.astral.sh/ruff/rules/#pyflakes-f
+    "G",  # https://docs.astral.sh/ruff/rules/#flake8-logging-format-g
+    "I",  # https://docs.astral.sh/ruff/rules/#isort-i
+    #"PTH", # https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth
+    "RUF",  # https://docs.astral.sh/ruff/rules/#ruff-specific-rules-ruf
+    "SIM",  # https://docs.astral.sh/ruff/rules/#flake8-simplify-sim
+    "TC",   # https://docs.astral.sh/ruff/rules/#flake8-type-checking-tc
+    "UP",   # https://docs.astral.sh/ruff/rules/#pyupgrade-up
+    "W",    # https://docs.astral.sh/ruff/rules/#warning-w
+    "PERF", # https://docs.astral.sh/ruff/rules/#perflint-perf
+    "ANN",  # https://docs.astral.sh/ruff/rules/#flake8-annotations-ann
+    "PGH",  # https://docs.astral.sh/ruff/rules/#pygrep-hooks-pgh
+    "RET",  # https://docs.astral.sh/ruff/rules/#flake8-return-ret
+    "PLE",  # https://docs.astral.sh/ruff/rules/#error-e_1
+]
+ignore = [
+    "F403",   # https://docs.astral.sh/ruff/rules/undefined-local-with-import-star/#undefined-local-with-import-star-f403
+    "SIM105", # https://docs.astral.sh/ruff/rules/suppressible-exception/
+    "E501",   # https://docs.astral.sh/ruff/rules/line-too-long/
+    "ANN401", # https://docs.astral.sh/ruff/rules/any-type/
+    "RET503", # https://docs.astral.sh/ruff/rules/implicit-return/
+    "RET502", # https://docs.astral.sh/ruff/rules/implicit-return-value/
+    "PGH003", # https://docs.astral.sh/ruff/rules/blanket-type-ignore
+    "E402", # https://docs.astral.sh/ruff/rules/module-import-not-at-top-of-file/
+]
+
+# [tool.ruff.lint.per-file-ignores]
+# "" = []
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[tool.pyright]
+include = ["dash", "idash"]
+pythonPlatform = "Windows"
+typeCheckingMode = "strict"
+reportPrivateUsage = false
+reportMissingTypeStubs = false

generate_plugin_file.py

@@ -1 +1,2 @@
-flogin==1.0.0
+flogin==1.0.0
+aioconsole==0.8.1