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.0.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.0-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyflowlauncher-1.0.0.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.0.tar.gz
Algorithm Hash digest
SHA256 fd50ddd1cf8ed49baeb7a22a3e2b299e3db27cfb69e7ae0a5a4322c296acdbcc
MD5 38236c62c61f2a0c163c1969c712ae30
BLAKE2b-256 bcf28be4ff4851362e20c79aadea39af0d9669568a47da859481f0cc9e651d69

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyflowlauncher-1.0.0.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.0-py3-none-any.whl.

File metadata

  • Download URL: pyflowlauncher-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 21.3 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 971d3240592af6d4310c5d97f97ccb2d605f52c1eb7ad1a81c373b522e12b51d
MD5 ec06a05d23caf10138d440f869f89658
BLAKE2b-256 18fdf355f601964b0e446a210ebf1013f22135f26a586b6c121771ef461ad576

See more details on using hashes here.

Provenance

The following attestation bundles were made for pyflowlauncher-1.0.0-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