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.2.tar.gz (16.8 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.2-py3-none-any.whl (21.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyflowlauncher-1.0.2.tar.gz
  • Upload date:
  • Size: 16.8 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.2.tar.gz
Algorithm Hash digest
SHA256 9856c95fa801c6627d4a315e4a360449374d1409f326aa6760dd091ca6c91b37
MD5 2769fe9fc8407c29f5c45ece31a99970
BLAKE2b-256 e8270d1fcd41493821caa01a47a58b9546b49f3db105a3a5d9bd35a3bcbdc6f6

See more details on using hashes here.

Provenance

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

Publisher: release-please.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.2-py3-none-any.whl.

File metadata

  • Download URL: pyflowlauncher-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 21.6 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 83264ba31e51bde077c0063050bb0ec26c7c2c80a4a080b2c6938f5b05218e4d
MD5 af08bbfaaf8893b6731b78b4efc2135d
BLAKE2b-256 1bd789ee9a9074401f634a666df56fd5335285e7e840bd847ee932485d264eb4

See more details on using hashes here.

Provenance

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

Publisher: release-please.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