update

Author: Zephyr-Wach

.github/workflows/Publish Release.yml

@@ -32,13 +32,24 @@ jobs:
         run: |
           python -m pip install --upgrade pip
           pip install -r requirements.txt -t ./lib
-          zip -r WebsiteOpener.zip . -x '*.git*' -x '*.github/*'
+          zip -r WebsiteOpener.zip . \
+            -x '*.git*' \
+            -x '*.github/*' \
+            -x '*.idea/*' \
+            -x '__pycache__/*' \
+            -x '*.DS_Store'
+
+      - name: Delete existing tag if exists
+        run: |
+          git tag -d v${{ steps.version.outputs.prop }} || true
+          git push origin :refs/tags/v${{ steps.version.outputs.prop }} || true
 
       - name: Publish Release
-        if: success()
         uses: softprops/action-gh-release@v1
         with:
           files: 'WebsiteOpener.zip'
           tag_name: "v${{ steps.version.outputs.prop }}"
+          name: "WebsiteOpener v${{ steps.version.outputs.prop }}"
+          body: "Auto release by GitHub Actions"
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.idea/.gitignore

@@ -0,0 +1 @@
+pip

.idea/WebsiteOpener.iml

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 William McAllister
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1,93 @@
+Metadata-Version: 2.1
+Name: pyflowlauncher
+Version: 0.9.2
+Summary: Python library to help build Flow Launcher plugins.
+Author-email: William McAllister <[email protected]>
+License: MIT
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: typing-extensions >=4.8.0 ; python_version < "3.11"
+Provides-Extra: all
+Requires-Dist: typing-extensions >=4.8.0 ; extra == 'all'
+
+[![Tests Workflow Status](https://img.shields.io/github/actions/workflow/status/garulf/pyflowlauncher/tests.yaml?style=flat-square&label=tests)](https://github.com/Garulf/pyFlowLauncher/actions/workflows/tests.yaml) 
+[![Docs Workflow Status](https://img.shields.io/github/actions/workflow/status/garulf/pyflowlauncher/tests.yaml?style=flat-square&label=docs)](https://github.com/Garulf/pyFlowLauncher/actions/workflows/docs.yaml) 
+[![Release Workflow Status](https://img.shields.io/github/actions/workflow/status/garulf/pyflowlauncher/create_release.yaml?style=flat-square&label=release)](https://github.com/Garulf/pyFlowLauncher/actions/workflows/create_release.yaml) 
+[![pypi](https://img.shields.io/pypi/v/pyflowlauncher?style=flat-square)](https://pypi.org/project/pyflowlauncher/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyflowlauncher)](https://pypi.org/project/pyflowlauncher/)
+[![GitHub License](https://img.shields.io/github/license/garulf/pyflowlauncher?style=flat-square)](./LICENSE)
+[![buymeacoffee](https://img.shields.io/badge/buy%20me%20a%20coffee-yellow.svg?style=flat-square&logo=buymeacoffee&logoColor=000)](https://www.buymeacoffee.com/garulf)
+
+# pyFlowLauncher
+
+pyFlowLauncher is an API that allows you to quickly create plugins for Flow Launcher!
+
+## Installation
+
+Install via pip:
+
+```py
+python -m pip install pyflowlauncher[all]
+```
+
+> [!IMPORTANT]
+> Please use the `[all]` flag in order to support Python versions older then `3.11`.
+
+## Usage
+
+### Basic plugin
+
+A basic plugin using a function as the query method.
+
+```py
+from pyflowlauncher import Plugin, Result, send_results
+from pyflowlauncher.result import ResultResponse
+
+plugin = Plugin()
+
+
+@plugin.on_method
+def query(query: str) -> ResultResponse:
+    r = Result(
+        Title="This is a title!",
+        SubTitle="This is the subtitle!",
+        IcoPath="icon.png"
+    )
+    return send_results([r])
+
+
+plugin.run()
+```
+
+### Advanced plugin
+
+A more advanced usage using a `Method` class as the query method.
+
+```py
+from pyflowlauncher import Plugin, Result, Method
+from pyflowlauncher.result import ResultResponse
+
+plugin = Plugin()
+
+
+class Query(Method):
+
+    def __call__(self, query: str) -> ResultResponse:
+        r = Result(
+            Title="This is a title!",
+            SubTitle="This is the subtitle!"
+        )
+        self.add_result(r)
+        return self.return_results()
+
+plugin.add_method(Query())
+plugin.run()
+```