viur-scriptor-api 1.2.0__tar.gz → 1.3.0__tar.gz

{viur_scriptor_api-1.2.0 → viur_scriptor_api-1.3.0}/PKG-INFO

@@ -1,8 +1,9 @@
 Metadata-Version: 2.4
 Name: viur-scriptor-api
-Version: 1.2.0
+Version: 1.3.0
 Summary: This is the internal Scriptor library that the viur-scriptor utilizes. The API includes components for networking as well as parts related to the Scriptor's files.
-Project-URL: Homepage, https://github.com/viur-framework/viur-scriptor-api
+Project-URL: Documentation, https://viur-scriptor-api.readthedocs.io
+Project-URL: Repository, https://github.com/viur-framework/viur-scriptor-api
 Project-URL: Bug Tracker, https://github.com/viur-framework/viur-scriptor-api/issues
 Author-email: Mausbrand Informationssysteme GmbH <devs@viur.dev>
 License-Expression: MIT
@@ -24,12 +25,13 @@ Description-Content-Type: text/markdown
 <div align="center">
     <img src="https://github.com/viur-framework/viur-artwork/raw/main/icons/icon-scriptor.svg" height="196" alt="A hexagonal logo of Scriptor" title="Scriptor logo">
     <h1>viur-scriptor-api</h1>
-    <!--
-    <a href="https://github.com/viur-framework/viur-scriptor/actions/workflows/test.yml">
-        <img src="https://github.com/viur-framework/viur-scriptor/actions/workflows/test.yml/badge.svg" alt="Badge displaying the test status" title="Test badge">
+    <a href="https://pypi.org/project/viur-scriptor-api/">
+        <img alt="Badge showing current PyPI version" title="PyPI" src="https://img.shields.io/pypi/v/viur-scriptor-api">
     </a>
-    -->
-    <a href="https://github.com/viur-framework/viur-scriptor/LICENSE">
+    <a href="https://viur-scriptor-api.readthedocs.io/en/latest/?badge=latest">
+        <img src="https://readthedocs.org/projects/viur-scriptor-api/badge/?version=latest" alt="Documentation Status">
+    </a>
+    <a href="LICENSE">
         <img src="https://img.shields.io/github/license/viur-framework/viur-scriptor-api" alt="Badge displaying the license" title="License badge">
     </a>
     <br>
@@ -48,12 +50,12 @@ You can use it either in the Pyodide-based scriptor as well as in native Python
 
 ## Documentation
 
-ReadTheDocs link follows soon, a gread documentation is already available in the source code!
+- [viur-scriptor-api.readthedocs.io](https://viur-scriptor-api.readthedocs.io/en/latest/)
 
 ## License
 
-Copyright © 2024 by Mausbrand Informationssysteme GmbH.<br>
+Copyright © 2025 by Mausbrand Informationssysteme GmbH.<br>
 Mausbrand and ViUR are registered trademarks of Mausbrand Informationssysteme GmbH.
 
-Logics is free software under the MIT license.<br>
+viur-scriptor-api is free software under the MIT license.<br>
 Please see the LICENSE file for details.

{viur_scriptor_api-1.2.0 → viur_scriptor_api-1.3.0}/README.md

@@ -1,12 +1,13 @@
 <div align="center">
     <img src="https://github.com/viur-framework/viur-artwork/raw/main/icons/icon-scriptor.svg" height="196" alt="A hexagonal logo of Scriptor" title="Scriptor logo">
     <h1>viur-scriptor-api</h1>
-    <!--
-    <a href="https://github.com/viur-framework/viur-scriptor/actions/workflows/test.yml">
-        <img src="https://github.com/viur-framework/viur-scriptor/actions/workflows/test.yml/badge.svg" alt="Badge displaying the test status" title="Test badge">
+    <a href="https://pypi.org/project/viur-scriptor-api/">
+        <img alt="Badge showing current PyPI version" title="PyPI" src="https://img.shields.io/pypi/v/viur-scriptor-api">
     </a>
-    -->
-    <a href="https://github.com/viur-framework/viur-scriptor/LICENSE">
+    <a href="https://viur-scriptor-api.readthedocs.io/en/latest/?badge=latest">
+        <img src="https://readthedocs.org/projects/viur-scriptor-api/badge/?version=latest" alt="Documentation Status">
+    </a>
+    <a href="LICENSE">
         <img src="https://img.shields.io/github/license/viur-framework/viur-scriptor-api" alt="Badge displaying the license" title="License badge">
     </a>
     <br>
@@ -25,12 +26,12 @@ You can use it either in the Pyodide-based scriptor as well as in native Python
 
 ## Documentation
 
-ReadTheDocs link follows soon, a gread documentation is already available in the source code!
+- [viur-scriptor-api.readthedocs.io](https://viur-scriptor-api.readthedocs.io/en/latest/)
 
 ## License
 
-Copyright © 2024 by Mausbrand Informationssysteme GmbH.<br>
+Copyright © 2025 by Mausbrand Informationssysteme GmbH.<br>
 Mausbrand and ViUR are registered trademarks of Mausbrand Informationssysteme GmbH.
 
-Logics is free software under the MIT license.<br>
+viur-scriptor-api is free software under the MIT license.<br>
 Please see the LICENSE file for details.

{viur_scriptor_api-1.2.0 → viur_scriptor_api-1.3.0}/pyproject.toml

@@ -45,5 +45,6 @@ packages = ["viur"]
 path = "viur/scriptor/__init__.py"
 
 [project.urls]
-"Homepage" = "https://github.com/viur-framework/viur-scriptor-api"
+"Documentation" = "https://viur-scriptor-api.readthedocs.io"
+"Repository" = "https://github.com/viur-framework/viur-scriptor-api"
 "Bug Tracker" = "https://github.com/viur-framework/viur-scriptor-api/issues"

{viur_scriptor_api-1.2.0 → viur_scriptor_api-1.3.0}/viur/scriptor/__init__.py

@@ -11,7 +11,7 @@ from requests.exceptions import ConnectionError
 from .directory_handler import DirectoryHandler
 from .progressbar import ProgressBar
 
-__version__ = '1.2.0'
+__version__ = '1.3.0'
 
 
 def version():

{viur_scriptor_api-1.2.0 → viur_scriptor_api-1.3.0}/viur/scriptor/dialog.py

@@ -655,7 +655,12 @@ class Dialog:
 
     if is_pyodide_context():
         @staticmethod
-        async def multiple(title: str, components: list, send_button_text: str, reuse: bool = False):
+        async def multiple(
+            title: str,
+            components: list[dict] | dict[str, dict],
+            send_button_text: str,
+            reuse: bool = False
+        ):
             """
             :param title: the header of the component
             :param components: list of components

{viur_scriptor_api-1.2.0 → viur_scriptor_api-1.3.0}/viur/scriptor/module_parts.py

@@ -147,7 +147,7 @@ class SingletonModule(BaseModule):
 
 
 class ExtendedModule(BaseModule):
-    async def list(self, params: dict = None, group: str = "", skel_type: str = "", **kwargs):
+    async def list(self, params: dict = None, group: str = "", skel_type: str = "", limit: int = None, **kwargs):
         if not params:
             params = {}
 
@@ -162,10 +162,6 @@ class ExtendedModule(BaseModule):
                 _url.append(group)
             _url = join_url(_url)
 
-        limit = None
-        if "limit" in params:
-            limit = params["limit"]
-
         batch = []
         cursor = None
         fetched = False
@@ -175,8 +171,8 @@ class ExtendedModule(BaseModule):
             for i in batch:
                 yield i
                 counter += 1
-            if limit and counter >= limit:
-                return
+                if limit and counter >= limit:
+                    return
             if fetched and not cursor:
                 return
             if cursor:
@@ -275,16 +271,18 @@ class ListModule(ExtendedModule):
         """
         return await super().add_or_edit(key=key, params=params, group=group, **kwargs)
 
-    async def list(self, params: dict = None, group: str = "", **kwargs):
+    async def list(self, params: dict = None, group: str = "", limit: int = None, **kwargs):
         """
         retrieves multiple records from the database (all if called without parameters)
 
         :param params: parameters to pass to the database
         :param group: the group the records belong to
+        :param limit: maximum amount of entries that should be fetched.
+            Note: The amount of entries per request/batch must be specified as "limit" in the params.
         :param kwargs: additional keyword-arguments
         :return: an asynchronous generator yielding the retrieved records
         """
-        async for i in super().list(params=params, group=group, **kwargs):
+        async for i in super().list(params=params, group=group, limit=limit, **kwargs):
             yield i
 
     async def add(self, params: dict = None, group: str = "", **kwargs):
@@ -409,16 +407,18 @@ class TreeModule(ExtendedModule):
         """
         return await super().edit(key=key, params=params, skel_type=skel_type, **kwargs)
 
-    async def list(self, params: dict = None, skel_type: str = "", **kwargs):
+    async def list(self, params: dict = None, skel_type: str = "", limit: int = None, **kwargs):
         """
         retrieves multiple records from the database (all if called without parameters)
 
         :param params: parameters to pass to the database
         :param skel_type: the skel_type of the record (either "node" or "leaf")
+        :param limit: maximum amount of entries that should be fetched.
+            Note: The amount of entries per request/batch must be specified as "limit" in the params.
         :param kwargs: additional keyword-arguments
         :return: an asynchronous generator yielding the retrieved records
         """
-        async for i in super().list(params=params, skel_type=skel_type, **kwargs):
+        async for i in super().list(params=params, skel_type=skel_type, limit=limit, **kwargs):
             yield i
 
     async def add(self, params: dict = None, skel_type: str = "", **kwargs):