Skip to main content

Tests Workflow Status Docs Workflow Status Release Workflow Status pypi PyPI - Python Version GitHub License buymeacoffee

pyFlowLauncher

pyFlowLauncher is an API that allows you to quickly create plugins for Flow Launcher!

Installation

Install via pip:

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.

from pyflowlauncher import Plugin, Result

plugin = Plugin()


@plugin.on_method
def query(query: str):
    yield Result(
        title="This is a title!",
        subtitle="This is the subtitle!",
        icon="icon.png"
    )


plugin.run()

Methods decorated with @plugin.on_method can yield one or more Result objects, return a list of Result objects, or return a single Result — the framework normalizes all forms into the correct response automatically.

Advanced plugin

A more advanced usage using a Method class as the query method.

from pyflowlauncher import Plugin, Result, Method
from .models.json_rpc import JsonRPCResponse

plugin = Plugin()


class Query(Method):

    def __call__(self, query: str) -> JsonRPCResponse:
        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()

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyflowlauncher-1.0.1.tar.gz (16.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyflowlauncher-1.0.1-py3-none-any.whl (21.4 kB view details)

Uploaded Python 3

File details

Details for the file pyflowlauncher-1.0.1.tar.gz.

File metadata

  • Download URL: pyflowlauncher-1.0.1.tar.gz
  • Upload date:
  • Size: 16.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyflowlauncher-1.0.1.tar.gz
Algorithm Hash digest
SHA256 3096b74c9676168ea72701b66e6974cfe16c01af017e408af12137a193216d04
MD5 3bf9fdc1f778ba213e541d01d291d78a
BLAKE2b-256 e80af94e69ea0c31cf61c41a04e3de815c2c4139e476499475cfdc2b28f14801

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyflowlauncher-1.0.1.tar.gz:

Publisher: pypi.yaml on Garulf/pyFlowLauncher

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pyflowlauncher-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: pyflowlauncher-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 21.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pyflowlauncher-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a7e03a9760152a2634d9ae98707be7a2cc4e7a7b8375929137a78a9742093043
MD5 829ef02f0885d479c94c6f5433d156b4
BLAKE2b-256 e3dd25dd8d39e3e155be370714f2bfbf0737fd25c5b7263d8390c8b813270c6d

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyflowlauncher-1.0.1-py3-none-any.whl:

Publisher: pypi.yaml on Garulf/pyFlowLauncher

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page