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())

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.1.tar.gz (36.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.1.1-py3-none-any.whl (10.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for flespi_sdk-0.1.1.tar.gz
Algorithm Hash digest
SHA256 c73b84d51d60a2e25979b3419a7bbf49f2e026c41d60a184eb91732722f4a522
MD5 f06b610553bdb032c252cd3e00c3c196
BLAKE2b-256 be566e3386e1796fb00c1ae753bc92a190c358ed52b037825b25f23ed0fe80fe

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for flespi_sdk-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 57bf2058be4ca704aa4cdb8c2d0d7d5d2fdec0b6b69f68e41c73448f4aa7b1c4
MD5 0fff7fa4d44db2f567566423cf6d043a
BLAKE2b-256 1da802842c14c2922ceea0bc6b67613d452550b43882a14e22a9d2123a812ceb

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