Skip to main content

Add your description here

Project description

Install

pip install flespi-sdk

Usage

from flespi_sdk.account import Account

# log into account
account = Account()
await account.set_token("<flespi-token>")
# or
# await account.realm_login("<realm-public-id>", "<realm-username>", "<realm-password>")

# use account

print("Metadata", await account.metadata.get())
print("Direct subaccount IDs", [subaccount.id for subaccount in await account.subaccounts.list()])
print("Flespi API counters", await account.mqtt.list("flespi/state/platform/customer/counters/api/#"))

Examples

Read emails from MQTT for all subaccounts (master token required)

from flespi_sdk.cli import get_account


async def main():
    account = None
    try:
        account = await get_account()
        subaccounts = await account.subaccounts.list()
        for subaccount in subaccounts:
            name = await subaccount.metadata.get_value("sys_user_config.title")
            mqtt_msg = await subaccount.mqtt.get("flespi/state/platform/customer/email")
            email = mqtt_msg["payload"]
            print(f"Subaccount ID: {subaccount.id}, Name: {name}, Email: {email}")
    except Exception as e:
        print("Error:", e)
    finally:
        if account:
            await account.stop()


if __name__ == "__main__":
    import asyncio

    asyncio.run(main())

Manipulate realms and users

acc = Account()
await acc.set_token(acc_token)

realms = await acc.realms.list(selector="all")
for realm in realms:
    print(realm.id, await realm.get_name(), await realm.metadata.get())
    users = await realm.users.list()
    for user in users:
        print(user.id, await user.get_name(), await user.metadata.get())

realm = await acc.realms.get(22644)
user = await realm.users.get(90287)
await user.metadata.set_value("test-metadata-key", "123")
print(await user.metadata.get())
await user.metadata.delete_value("test-metadata-key")
print(await user.metadata.get())
await user.update_password("newpassword123456789")

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

flespi_sdk-0.1.4.tar.gz (45.4 kB view details)

Uploaded Source

Built Distribution

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

flespi_sdk-0.1.4-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file flespi_sdk-0.1.4.tar.gz.

File metadata

  • Download URL: flespi_sdk-0.1.4.tar.gz
  • Upload date:
  • Size: 45.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.15

File hashes

Hashes for flespi_sdk-0.1.4.tar.gz
Algorithm Hash digest
SHA256 06a70471c937d96f36e854105f70994a14a483f4851c2a1a88a2d13c98aabaaf
MD5 0d282e135d84daecde9df0529567e0af
BLAKE2b-256 18eca8ad398bf49baf39e6b2e843b560c02d49027e34ef2323c8f2ae4502844d

See more details on using hashes here.

File details

Details for the file flespi_sdk-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: flespi_sdk-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 14.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.15

File hashes

Hashes for flespi_sdk-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 9254eedd74b6c4986fdcb1fc7dbbde85431ce5a6c438706effb554059174846b
MD5 a706c795091187b92904a8c6e17ac63c
BLAKE2b-256 c6b42d9e943c41fc998b9f0ce42e3f5605f450efcb532af5a221a7b78d2faffc

See more details on using hashes here.

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