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.0.0.tar.gz (38.9 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.0.0-py3-none-any.whl (45.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for flogin-1.0.0.tar.gz
Algorithm Hash digest
SHA256 61b1f8d0ff8482a212c86bcb1fe8ed21973abe8f580a25331f3a0e0e50aaf397
MD5 b09d53876e246a76d23609f8f0f77d1c
BLAKE2b-256 cfac4d610082251436aa6185f6517dacd31bfd58e9fab3dca2c37e8f05a15502

See more details on using hashes here.

Provenance

The following attestation bundles were made for flogin-1.0.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.0.0-py3-none-any.whl.

File metadata

  • Download URL: flogin-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 45.7 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.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 68188fc4c5d38e865d4508946c5bfa74b1012390f893074765c3700ef0b4218e
MD5 83302c244dc1521e423967f6841d41fb
BLAKE2b-256 c5f0d45c6d3fcbcf08d68b74660b4b82f63756d0d46007878562324bfba35cad

See more details on using hashes here.

Provenance

The following attestation bundles were made for flogin-1.0.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