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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for flespi_sdk-0.2.2.tar.gz
Algorithm Hash digest
SHA256 c114e52cd5c37bcf1ca76035d755ae4a1298d3080fe2fb96da887d3e9e9c8319
MD5 556c54881f6fa788390dd7c57782a8b9
BLAKE2b-256 677899f8a6024f5610850f5bb3d65d986282802ef7dbf08e1e1469d01a34b39f

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for flespi_sdk-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d2239828943c9ebd2cf09ea59e0ba14e7c1327aaf68f83a407e17d460f663ddf
MD5 da5bd302e780efbaf8110834cd231164
BLAKE2b-256 92543b91cb3add2562bac483e46d9c6bc0c2455e49e61397ebdcc2570cbe6499

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