Skip to main content

A Python wrapper for Flow Launcher's v2 python api

Project description

flogin

Tests Workflow Status Build Workflow Status Lint Workflow Status PyPI version info PyPI supported Python versions Stable Documentation Dev/Latest Documentation

A wrapper for Flow Lancher’s V2 jsonrpc api using python, to easily and quickly make Flow launcher plugins.

Key Features

  • Modern Pythonic API using async and await.

  • Fully Typed

  • Easy to use with an object oriented design

Installing

Python 3.11 or higher is required

To install flogin, do the following:

pip install flogin

To install the development version, ensure git is installed, then do the following:

pip install git+https://github.com/cibere/flogin

Basic Example

from flogin import Plugin, Query

plugin = Plugin()

@plugin.search()
async def on_query(data: Query):
    return f"You wrote {data.text}"

plugin.run()

You can find more examples in the examples directory.

Contributing

Contributions are greatly appriciated, I just have a couple of requests:

  1. Your code is run through isort and black

  2. Your code is properly typed

  3. Your code is tested

  4. Your code is documented

Project details


Download files

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

Source Distribution

flogin-1.1.0.tar.gz (41.1 kB view details)

Uploaded Source

Built Distribution

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

flogin-1.1.0-py3-none-any.whl (48.2 kB view details)

Uploaded Python 3

File details

Details for the file flogin-1.1.0.tar.gz.

File metadata

  • Download URL: flogin-1.1.0.tar.gz
  • Upload date:
  • Size: 41.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for flogin-1.1.0.tar.gz
Algorithm Hash digest
SHA256 21f7f5931478fd60901d0862a86e7c7a53fef0a2ce961073fcd34e2f1e9e8f71
MD5 efe02652676194cdd83ba366dca4298f
BLAKE2b-256 3658061deeaf3cfcdc7954d5e1d9f2afac72d52584a1be178f0149dd8df566bb

See more details on using hashes here.

Provenance

The following attestation bundles were made for flogin-1.1.0.tar.gz:

Publisher: python-publish.yml on cibere/flogin

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

File details

Details for the file flogin-1.1.0-py3-none-any.whl.

File metadata

  • Download URL: flogin-1.1.0-py3-none-any.whl
  • Upload date:
  • Size: 48.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.0.1 CPython/3.12.8

File hashes

Hashes for flogin-1.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 14c7ce8d15bcdc733e7bde2d35992b9affb9aeb0e44baa650b1236739d9b4b5c
MD5 085fd08eb900f4a40ba8d853de0bbe94
BLAKE2b-256 7d75467dbb379ceb40cedc342aa3e2bd4a4dd8598ac35cc7d285de0b598c3254

See more details on using hashes here.

Provenance

The following attestation bundles were made for flogin-1.1.0-py3-none-any.whl:

Publisher: python-publish.yml on cibere/flogin

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 Pingdom Monitoring Sentry Error logging StatusPage Status page