flespi-sdk 0.1.0__tar.gz → 0.1.1__tar.gz

flespi_sdk-0.1.1/PKG-INFO

@@ -0,0 +1,87 @@
+Metadata-Version: 2.4
+Name: flespi-sdk
+Version: 0.1.1
+Summary: Add your description here
+Author-email: Sergey Shevchik <sergey.shevchik@gmail.com>
+Requires-Python: >=3.11
+Requires-Dist: aiohttp>=3.11.15
+Description-Content-Type: text/markdown
+
+# Install
+
+```
+pip install flespi-sdk
+
+```
+
+# Usage
+
+```python
+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)
+
+```python
+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
+
+```python
+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())
+```

flespi_sdk-0.1.1/README.md

@@ -0,0 +1,78 @@
+# Install
+
+```
+pip install flespi-sdk
+
+```
+
+# Usage
+
+```python
+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)
+
+```python
+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
+
+```python
+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())
+```

{flespi_sdk-0.1.0 → flespi_sdk-0.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "flespi-sdk"
-version = "0.1.0"
+version = "0.1.1"
 description = "Add your description here"
 readme = "README.md"
 authors = [

{flespi_sdk-0.1.0 → flespi_sdk-0.1.1}/src/flespi_sdk/account.py

@@ -2,6 +2,7 @@ from aiohttp import ClientSession
 
 from flespi_sdk.modules.metadata import Metadata
 from flespi_sdk.modules.mqtt import MQTT
+from flespi_sdk.modules.realms import Realms
 from flespi_sdk.modules.subaccounts import Subaccounts
 
 
@@ -70,6 +71,7 @@ class Account:
             self._init_modules()
 
     def _init_modules(self):
-        self.metadata = Metadata(self.session, self.id)
+        self.metadata = Metadata("platform/customer", self.session, self.id)
         self.subaccounts = Subaccounts(self.session, self.id)
+        self.realms = Realms(self.session, self.id)
         self.mqtt = MQTT(self.session, self.id)

flespi_sdk-0.1.0/src/flespi_sdk/modules/subsystem.py → flespi_sdk-0.1.1/src/flespi_sdk/modules/flespi_session.py

@@ -1,7 +1,7 @@
 from aiohttp import ClientSession
 
 
-class Module:
+class FlespiSession:
     def __init__(self, session: ClientSession, cid: int | None = None):
         self.cid = cid
         self.session = session

flespi_sdk-0.1.1/src/flespi_sdk/modules/item_with_metadata.py

@@ -0,0 +1,31 @@
+from aiohttp import ClientSession
+from flespi_sdk.modules.flespi_session import FlespiSession
+from flespi_sdk.modules.metadata import Metadata
+
+
+class ItemWithMetadata(FlespiSession):
+    def __init__(
+        self,
+        parent_id: int | None,
+        id: int,
+        item_path: str,
+        session: ClientSession,
+        cid: int | None = None,
+    ):
+        super().__init__(session, cid)
+        self.parent_id = parent_id
+        self.id = id
+        self.item_path = item_path
+        self.metadata = Metadata(item_path, session, cid)
+
+    async def get_name(self) -> str:
+        """
+        Get the name of the item.
+        :return: The name of the item.
+        """
+        async with self.session.get(
+            f"/{self.item_path}",
+            headers=self.get_headers(),
+        ) as response:
+            result = await self.get_result(response)
+            return result[0]["name"]

flespi_sdk-0.1.1/src/flespi_sdk/modules/items_container.py

@@ -0,0 +1,42 @@
+# from aiohttp import ClientSession
+# from flespi_sdk.modules.realms.users.user import User
+# from flespi_sdk.modules.flespi_session import FlespiSession
+
+
+# class ItemsContainer(FlespiSession):
+#     """
+#     The RealmUsers class provides methods to manage users in a specific realm.
+#     It allows for the retrieval of user information and the management of user roles.
+#     """
+
+#     def __init__(
+#         self,
+#         items_path: str,
+#         item_class: type,
+#         client_session: ClientSession,
+#         cid: int | None = None,
+#     ):
+#         """
+#         Initializes the RealmUsers class with a client instance.
+
+#         :param client: The client instance used to make API requests.
+#         """
+#         super().__init__(client_session, cid)
+#         self.items_path = items_path
+#         self.itemClass = item_class
+
+#     async def list(self, selector: str = "all"):
+#         """
+#         List all users in the realm.
+#         :param selector: The selector to filter users.
+#         :return: A list of User objects.
+#         """
+#         async with self.session.get(
+#             f"{self.items_path}/{selector}",
+#             headers=self.get_headers(),
+#         ) as response:
+#             result = await self.get_result(response)
+#             return [
+#                 self.itemClass(self.realm_id, user["id"], self.session, self.cid)
+#                 for user in result
+#             ]

{flespi_sdk-0.1.0 → flespi_sdk-0.1.1}/src/flespi_sdk/modules/metadata/__init__.py

@@ -1,11 +1,14 @@
 import aiohttp
 
-from flespi_sdk.modules.subsystem import Module
+from flespi_sdk.modules.flespi_session import FlespiSession
 
 
-class Metadata(Module):
-    def __init__(self, session: aiohttp.ClientSession, cid: int | None = None):
+class Metadata(FlespiSession):
+    def __init__(
+        self, item_path, session: aiohttp.ClientSession, cid: int | None = None
+    ):
         super().__init__(session, cid)
+        self.item_path = item_path
 
     async def get(self) -> dict:
         """
@@ -14,7 +17,7 @@ class Metadata(Module):
         """
         params = {"fields": "metadata"}
         async with self.session.get(
-            "platform/customer", params=params, headers=self.get_headers()
+            self.item_path, params=params, headers=self.get_headers()
         ) as response:
             result = await self.get_result(response)
             return result[0]["metadata"]
@@ -25,7 +28,7 @@ class Metadata(Module):
         :param metadata: Metadata as a dictionary.
         """
         async with self.session.put(
-            "platform/customer",
+            self.item_path,
             json={"metadata": metadata},
             headers=self.get_headers(),
         ) as response:
@@ -38,6 +41,8 @@ class Metadata(Module):
         :return: The value from the metadata.
         """
         metadata = await self.get()
+        if not metadata:
+            return None
         keys = key_path.split(".")
         value = metadata
         for key in keys:
@@ -53,14 +58,14 @@ class Metadata(Module):
         :param key_path: The key path to the value in the metadata.
         :param value: The value to set.
         """
-        metadata = await self.get()
+        metadata = await self.get() or {}
         keys = key_path.split(".")
-        d = metadata
+        metadata_level = metadata
         for key in keys[:-1]:
-            if key not in d:
-                d[key] = {}
-            d = d[key]
-        d[keys[-1]] = value
+            if key not in metadata_level:
+                metadata_level[key] = {}
+            metadata_level = metadata_level[key]
+        metadata_level[keys[-1]] = value
         await self.set(metadata)
 
     async def delete_value(self, key_path: str) -> None:
@@ -69,12 +74,14 @@ class Metadata(Module):
         :param key_path: The key path to the value in the metadata.
         """
         metadata = await self.get()
+        if not metadata:
+            return
         keys = key_path.split(".")
-        value = metadata
+        metadata_level = metadata
         for key in keys[:-1]:
-            if key in value:
-                value = value[key]
+            if key in metadata_level:
+                metadata_level = metadata_level[key]
             else:
                 return None
-        del value[keys[-1]]
+        del metadata_level[keys[-1]]
         await self.set(metadata)

{flespi_sdk-0.1.0 → flespi_sdk-0.1.1}/src/flespi_sdk/modules/mqtt/__init__.py

@@ -1,10 +1,10 @@
 import urllib.parse
 
 import aiohttp
-from flespi_sdk.modules.subsystem import Module
+from flespi_sdk.modules.flespi_session import FlespiSession
 
 
-class MQTT(Module):
+class MQTT(FlespiSession):
     def __init__(self, session: aiohttp.ClientSession, cid: int | None = None):
         super().__init__(session, cid)
 

flespi_sdk-0.1.1/src/flespi_sdk/modules/realms/__init__.py

@@ -0,0 +1,32 @@
+import aiohttp
+
+from flespi_sdk.modules.realms.realm import Realm
+from flespi_sdk.modules.flespi_session import FlespiSession
+
+
+class Realms(FlespiSession):
+    def __init__(self, session: aiohttp.ClientSession, cid: int | None = None):
+        super().__init__(session, cid)
+
+    async def get(self, id: int):
+        async with self.session.get(
+            f"/platform/realms/{id}", headers=self.get_headers()
+        ) as response:
+            result = await self.get_result(response)
+            realm = result[0]
+            return Realm(
+                realm_id=realm["id"],
+                session=self.session,
+                cid=self.cid,
+            )
+
+    async def list(self, selector: str = "all"):
+        async with self.session.get(
+            f"/platform/realms/{selector}",
+            headers=self.get_headers(),
+        ) as response:
+            result = await self.get_result(response)
+            return [
+                Realm(realm_id=realm["id"], session=self.session, cid=self.cid)
+                for realm in result
+            ]

flespi_sdk-0.1.1/src/flespi_sdk/modules/realms/realm.py

@@ -0,0 +1,21 @@
+from aiohttp import ClientSession
+
+from flespi_sdk.modules.realms.users import Users
+from flespi_sdk.modules.item_with_metadata import ItemWithMetadata
+
+
+class Realm(ItemWithMetadata):
+    """
+    Represents a realm in the Flespi system.
+    """
+
+    def __init__(self, realm_id: int, session: ClientSession, cid: int | None = None):
+        item_path = f"platform/realms/{realm_id}"
+        super().__init__(
+            parent_id=None, id=realm_id, item_path=item_path, session=session, cid=cid
+        )
+        self.users = Users(
+            realm_id=realm_id,
+            client_session=session,
+            cid=cid,
+        )

flespi_sdk-0.1.1/src/flespi_sdk/modules/realms/users/__init__.py

@@ -0,0 +1,53 @@
+from aiohttp import ClientSession
+from flespi_sdk.modules.realms.users.user import User
+from flespi_sdk.modules.flespi_session import FlespiSession
+
+
+class Users(FlespiSession):
+    """
+    The RealmUsers class provides methods to manage users in a specific realm.
+    It allows for the retrieval of user information and the management of user roles.
+    """
+
+    def __init__(
+        self,
+        realm_id: int,
+        client_session: ClientSession,
+        cid: int | None = None,
+    ):
+        """
+        Initializes the RealmUsers class with a client instance.
+
+        :param client: The client instance used to make API requests.
+        """
+        super().__init__(client_session, cid)
+        self.realm_id = realm_id
+
+    async def get(self, user_id: int) -> User:
+        """
+        Get a user by ID.
+        :param user_id: The ID of the user to retrieve.
+        :return: A User object.
+        """
+        async with self.session.get(
+            f"/platform/realms/{self.realm_id}/users/{user_id}",
+            headers=self.get_headers(),
+        ) as response:
+            result = await self.get_result(response)
+            return User(self.realm_id, result[0]["id"], self.session, self.cid)
+
+    async def list(self, selector: str = "all") -> list[User]:
+        """
+        List all users in the realm.
+        :param selector: The selector to filter users.
+        :return: A list of User objects.
+        """
+        async with self.session.get(
+            f"/platform/realms/{self.realm_id}/users/{selector}",
+            headers=self.get_headers(),
+        ) as response:
+            result = await self.get_result(response)
+            return [
+                User(self.realm_id, user["id"], self.session, self.cid)
+                for user in result
+            ]

flespi_sdk-0.1.1/src/flespi_sdk/modules/realms/users/user.py

@@ -0,0 +1,25 @@
+from aiohttp import ClientSession
+from flespi_sdk.modules.item_with_metadata import ItemWithMetadata
+
+
+class User(ItemWithMetadata):
+    def __init__(
+        self,
+        realm_id: int,
+        user_id: int,
+        session: ClientSession,
+        cid: int | None = None,
+    ):
+        """
+        Initializes the RealmUsers class with a client instance.
+
+        :param client: The client instance used to make API requests.
+        """
+        item_path = f"platform/realms/{realm_id}/users/{user_id}"
+        super().__init__(
+            parent_id=realm_id,
+            id=user_id,
+            item_path=item_path,
+            session=session,
+            cid=cid,
+        )

{flespi_sdk-0.1.0 → flespi_sdk-0.1.1}/src/flespi_sdk/modules/subaccounts/__init__.py

@@ -1,13 +1,13 @@
 import aiohttp
 
-from flespi_sdk.modules.subsystem import Module
+from flespi_sdk.modules.flespi_session import FlespiSession
 
 
-class Subaccounts(Module):
+class Subaccounts(FlespiSession):
     def __init__(self, session: aiohttp.ClientSession, cid: int | None = None):
         super().__init__(session, cid)
 
-    async def get_by_id(self, id: str):
+    async def get(self, id: str):
         from flespi_sdk.account import Account
 
         async with self.session.get(

flespi_sdk-0.1.0/PKG-INFO

@@ -1,7 +0,0 @@
-Metadata-Version: 2.4
-Name: flespi-sdk
-Version: 0.1.0
-Summary: Add your description here
-Author-email: Sergey Shevchik <sergey.shevchik@gmail.com>
-Requires-Python: >=3.11
-Requires-Dist: aiohttp>=3.11.15