arkitekt-next 0.7.8__tar.gz

arkitekt_next-0.7.8/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Johannes Roos <jhnnsrs@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

arkitekt_next-0.7.8/PKG-INFO

@@ -0,0 +1,155 @@
+Metadata-Version: 2.1
+Name: arkitekt-next
+Version: 0.7.8
+Summary: client for the arkitekt_next platform
+License: MIT
+Author: jhnnsrs
+Author-email: jhnnsrs@gmail.com
+Requires-Python: >=3.8,<4.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Provides-Extra: all
+Provides-Extra: cli
+Requires-Dist: dokker (>=0.1.21)
+Requires-Dist: fakts (>=0.5.0)
+Requires-Dist: fluss-next (>=0.1.61) ; extra == "all"
+Requires-Dist: herre (>=0.4.3)
+Requires-Dist: kabinet (>=0.1.19) ; extra == "all"
+Requires-Dist: koil (>=0.3.6)
+Requires-Dist: mikro-next (>=0.1.6) ; (python_version >= "3.10" and python_version < "4.0") and (extra == "all")
+Requires-Dist: reaktion-next (>=0.1.50) ; (python_version >= "3.8" and python_version < "4.0") and (extra == "all")
+Requires-Dist: rich-click (>=1.6.1) ; extra == "cli" or extra == "all"
+Requires-Dist: semver (>=3.0.1) ; extra == "cli" or extra == "all"
+Requires-Dist: turms (>=0.5.0) ; (python_version >= "3.9" and python_version < "4.0") and (extra == "cli" or extra == "all")
+Requires-Dist: watchfiles (>=0.18.1) ; extra == "cli" or extra == "all"
+Description-Content-Type: text/markdown
+
+# arkitekt_next
+
+[![codecov](https://codecov.io/gh/jhnnsrs/arkitekt_next/branch/master/graph/badge.svg?token=UGXEA2THBV)](https://codecov.io/gh/jhnnsrs/arkitekt_next)
+[![PyPI version](https://badge.fury.io/py/arkitekt_next.svg)](https://pypi.org/project/arkitekt_next/)
+[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://pypi.org/project/arkitekt_next/)
+![Maintainer](https://img.shields.io/badge/maintainer-jhnnsrs-blue)
+[![PyPI pyversions](https://img.shields.io/pypi/pyversions/arkitekt_next.svg)](https://pypi.python.org/pypi/arkitekt_next/)
+[![PyPI status](https://img.shields.io/pypi/status/arkitekt_next.svg)](https://pypi.python.org/pypi/arkitekt_next/)
+
+streaming analysis for mikroscopy
+
+## Idea
+
+arkitekt_next is the python client for the arkitekt_next platform. It allows you to utilize the full extent of the platform from your python code.
+To understand the idea behind arkitekt_next, you need to understand the idea behind the arkitekt_next platform.
+(More on this in the [documentation](https://arkitekt_next.live))
+
+## Features
+
+- Host your python functions and make them to your team
+- Use functions from your team in your code
+- Interact with and store data in a secure and scalable way on the platform
+- Use the platform as a central storage for your data
+
+## Install
+
+```bash
+pip install arkitekt_next[all]
+```
+
+This installs all dependencies for the arkitekt_next platform, inlcuding the arkitekt_next CLI, which can be used to develop and create apps, containerize them and deploy t
+
+
+arkitekt_next is relying heavily on asyncio patters and therfore supports python 3.8 and above. It also relies on the pydantic stack for serialization.
+
+
+## App 
+
+You can use the cli to create python based apps for the arkitekt_next platform, profiting from a battery of features like easy GUI creation based on
+type annotations, orchestration of real-time (in memoery) workflows, data hosting,  easy packaging and distribution in docker containers, etc...
+
+To get started create a directory and run
+
+```bash
+arkitekt_next init
+```
+
+Which will lead you throught an app creation process.
+Apps can simply registered functions, through the register decorator
+
+```python
+from arkitekt_next import register
+
+@register()
+def rpc_function(x: int, name: str) -> str
+    """
+    A rpc function that we can
+    simple call from anywhere
+
+    ""
+
+```
+
+And then connected to a local or remote server by running
+
+Run example:
+
+```bash
+arkitekt_next run dev
+```
+
+
+For more details on how to create an app follow the tutorials on https://arkitekt_next.live.
+
+## Usage with complex Datastructures
+
+ArkitektNext takes care of serialization and documentation of standard python datastructures
+
+- str
+- bool
+- int
+- float
+- Enum
+- Dict
+- List
+
+To increase performance and reduce latency it is not possible to serialize complex python objects like numpy arrays into the messages. These are best transformed into immutable objects on a centrally accessible storage and then only the reference is passed.
+
+ArkitektNext does not impose any rules on how you handle this storage (see mikro for ideas), it provides however a simple api.
+
+```python
+
+class ComplexStructure:
+    id: str # A reference for this structure on central storage
+
+    async def shrink(self):
+        return self.id
+
+    @classmethod
+    async def expand(cls, value):
+        return cls.load_from_server(value)
+
+
+```
+
+by providing two functions:
+
+- shrink
+- expand
+
+You can now use this Structure with simple typehints and arkitekt_next will automaticall shrink (serialize) and expand (deserialize) the structure on calling.
+
+```python
+
+def complex_call(x: ComplexStrucuture) -> int:
+    return x.max()
+
+```
+
+
+
+Check out the arkitekt_next [documentation](https://arkitekt_next.live) for usage of this libary
+
+

arkitekt_next-0.7.8/README.md

@@ -0,0 +1,123 @@
+# arkitekt_next
+
+[![codecov](https://codecov.io/gh/jhnnsrs/arkitekt_next/branch/master/graph/badge.svg?token=UGXEA2THBV)](https://codecov.io/gh/jhnnsrs/arkitekt_next)
+[![PyPI version](https://badge.fury.io/py/arkitekt_next.svg)](https://pypi.org/project/arkitekt_next/)
+[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://pypi.org/project/arkitekt_next/)
+![Maintainer](https://img.shields.io/badge/maintainer-jhnnsrs-blue)
+[![PyPI pyversions](https://img.shields.io/pypi/pyversions/arkitekt_next.svg)](https://pypi.python.org/pypi/arkitekt_next/)
+[![PyPI status](https://img.shields.io/pypi/status/arkitekt_next.svg)](https://pypi.python.org/pypi/arkitekt_next/)
+
+streaming analysis for mikroscopy
+
+## Idea
+
+arkitekt_next is the python client for the arkitekt_next platform. It allows you to utilize the full extent of the platform from your python code.
+To understand the idea behind arkitekt_next, you need to understand the idea behind the arkitekt_next platform.
+(More on this in the [documentation](https://arkitekt_next.live))
+
+## Features
+
+- Host your python functions and make them to your team
+- Use functions from your team in your code
+- Interact with and store data in a secure and scalable way on the platform
+- Use the platform as a central storage for your data
+
+## Install
+
+```bash
+pip install arkitekt_next[all]
+```
+
+This installs all dependencies for the arkitekt_next platform, inlcuding the arkitekt_next CLI, which can be used to develop and create apps, containerize them and deploy t
+
+
+arkitekt_next is relying heavily on asyncio patters and therfore supports python 3.8 and above. It also relies on the pydantic stack for serialization.
+
+
+## App 
+
+You can use the cli to create python based apps for the arkitekt_next platform, profiting from a battery of features like easy GUI creation based on
+type annotations, orchestration of real-time (in memoery) workflows, data hosting,  easy packaging and distribution in docker containers, etc...
+
+To get started create a directory and run
+
+```bash
+arkitekt_next init
+```
+
+Which will lead you throught an app creation process.
+Apps can simply registered functions, through the register decorator
+
+```python
+from arkitekt_next import register
+
+@register()
+def rpc_function(x: int, name: str) -> str
+    """
+    A rpc function that we can
+    simple call from anywhere
+
+    ""
+
+```
+
+And then connected to a local or remote server by running
+
+Run example:
+
+```bash
+arkitekt_next run dev
+```
+
+
+For more details on how to create an app follow the tutorials on https://arkitekt_next.live.
+
+## Usage with complex Datastructures
+
+ArkitektNext takes care of serialization and documentation of standard python datastructures
+
+- str
+- bool
+- int
+- float
+- Enum
+- Dict
+- List
+
+To increase performance and reduce latency it is not possible to serialize complex python objects like numpy arrays into the messages. These are best transformed into immutable objects on a centrally accessible storage and then only the reference is passed.
+
+ArkitektNext does not impose any rules on how you handle this storage (see mikro for ideas), it provides however a simple api.
+
+```python
+
+class ComplexStructure:
+    id: str # A reference for this structure on central storage
+
+    async def shrink(self):
+        return self.id
+
+    @classmethod
+    async def expand(cls, value):
+        return cls.load_from_server(value)
+
+
+```
+
+by providing two functions:
+
+- shrink
+- expand
+
+You can now use this Structure with simple typehints and arkitekt_next will automaticall shrink (serialize) and expand (deserialize) the structure on calling.
+
+```python
+
+def complex_call(x: ComplexStrucuture) -> int:
+    return x.max()
+
+```
+
+
+
+Check out the arkitekt_next [documentation](https://arkitekt_next.live) for usage of this libary
+

arkitekt_next-0.7.8/arkitekt_next/__init__.py

@@ -0,0 +1,43 @@
+def missing_install(name: str, error: Exception):
+    def real_missing_install(*args, **kwargs):
+        raise ImportError(
+            f"Missing import: {name}. Please install the missing package. "
+        ) from error
+
+    return real_missing_install
+
+
+try:
+    from rekuest_next.register import register
+    from rekuest_next.agents.hooks import background
+    from rekuest_next.agents.hooks import startup
+except ImportError as e:
+    raise e
+    register = missing_install("rekuest_next", e)
+    background = missing_install("rekuest_next", e)
+    startup = missing_install("rekuest_next", e)
+
+from .builders import easy
+from .apps.types import App
+
+__all__ = [
+    "App",
+    "register",
+    "easy",
+    "publicqt",
+    "jupy",
+    "log",
+    "alog",
+    "progress",
+    "aprogress",
+    "scheduler",
+    "register_structure",
+    "group",
+    "useGuardian",
+    "useInstanceID",
+    "useUser",
+    "next",
+    "background",
+    "startup",
+    "register_next",
+]

arkitekt_next-0.7.8/arkitekt_next/apps/__init__.py

@@ -0,0 +1,3 @@
+from .types import App
+
+__all__ = ["App"]

arkitekt_next-0.7.8/arkitekt_next/apps/easy.py

@@ -0,0 +1,99 @@
+from .types import EasyApp
+from typing import Optional, List
+
+
+def build_arkitekt_app(
+    manifest: Manifest,
+    url=None,
+    no_cache=False,
+    headless=False,
+    instance_id=None,
+    token=None,
+    app_kind="development",
+    redeem_token=None,
+):
+    if redeem_token:
+        fakts = build_arkitekt_next_redeem_fakts_next(
+            manifest=manifest,
+            redeem_token=redeem_token,
+            url=url,
+            no_cache=no_cache,
+            headless=headless,
+        )
+    else:
+        fakts = build_arkitekt_next_fakts_next(
+            manifest=manifest,
+            url=url,
+            no_cache=no_cache,
+            headless=headless,
+            client_kind=app_kind,
+        )
+
+    herre = build_arkitekt_next_herre(fakts=fakts)
+
+    try:
+        from arkitekt_next_next.apps.service.rekuest_next import build_arkitekt_next_rekuest_next
+
+        rekuest = build_arkitekt_next_rekuest_next(
+            fakts=fakts, herre=herre, instance_id=instance_id
+        )
+    except ImportError as e:
+        rekuest = ImportException(import_exception=e, install_library="rekuest_next")
+
+    try:
+        from arkitekt_next_next.apps.service.mikro_next import build_arkitekt_next_mikro_next
+
+        mikro = build_arkitekt_next_mikro_next(fakts=fakts, herre=herre)
+    except ImportError as e:
+        raise e
+        mikro = ImportException(import_exception=e, install_library="mikro_next")
+
+    try:
+        from arkitekt_next_next.apps.service.fluss_next import build_arkitekt_next_fluss
+
+        fluss = build_arkitekt_next_fluss(herre=herre, fakts=fakts)
+    except ImportError as e:
+        raise e
+        fluss = ImportException(import_exception=e, install_library="fluss_next")
+
+    try:
+        from arkitekt_next_next.apps.service.unlok_next import build_arkitekt_next_unlok_next
+
+        unlok = build_arkitekt_next_unlok_next(herre=herre, fakts=fakts)
+    except ImportError as e:
+        raise e
+        fluss = ImportException(import_exception=e, install_library="fluss_next")
+
+    try:
+        from arkitekt_next_next.apps.service.omero_ark import build_arkitekt_next_omero_ark
+
+        omero_ark = build_arkitekt_next_omero_ark(herre=herre, fakts=fakts)
+    except ImportError as e:
+        omero_ark = ImportException(import_exception=e, install_library="omero_ark")
+
+    try:
+        from arkitekt_next_next.apps.service.kluster import build_arkitekt_next_kluster
+
+        kluster = build_arkitekt_next_kluster(herre=herre, fakts=fakts)
+    except ImportError as e:
+        kluster = ImportException(import_exception=e, install_library="kluster")
+
+    try:
+        from arkitekt_next_next.apps.service.kabinet import build_arkitekt_next_kabinet
+
+        kabinet = build_arkitekt_next_kabinet(herre=herre, fakts=fakts)
+    except ImportError as e:
+        kabinet = ImportException(import_exception=e, install_library="kluster")
+
+    return NextApp(
+        manifest=manifest,
+        fakts=fakts,
+        herre=herre,
+        rekuest=rekuest,
+        mikro=mikro,
+        kabinet=kabinet,
+        unlok=unlok,
+        fluss=fluss,
+        kluster=kluster,
+        omero_ark=omero_ark,
+    )

arkitekt_next-0.7.8/arkitekt_next/apps/next.py

@@ -0,0 +1,40 @@
+from arkitekt_next_next.apps.fallbacks import ImportException
+from arkitekt_next_next.apps.service.fakts_next import (
+    build_arkitekt_next_fakts_next,
+    build_arkitekt_next_redeem_fakts_next,
+)
+from arkitekt_next_next.apps.service.herre import build_arkitekt_next_herre
+from arkitekt_next_next.model import Manifest
+
+from .types import NextApp
+
+
+def build_next_app(
+    manifest: Manifest,
+    url=None,
+    no_cache=False,
+    headless=False,
+    instance_id=None,
+    token=None,
+    app_kind="development",
+    redeem_token=None,
+):
+    if redeem_token:
+        fakts = build_arkitekt_next_redeem_fakts_next(
+            manifest=manifest,
+            redeem_token=redeem_token,
+            url=url,
+            no_cache=no_cache,
+            headless=headless,
+        )
+    else:
+        fakts = build_arkitekt_next_fakts_next(
+            manifest=manifest,
+            url=url,
+            no_cache=no_cache,
+            headless=headless,
+            client_kind=app_kind,
+        )
+
+    herre = build_arkitekt_next_herre(fakts=fakts)
+

arkitekt_next-0.7.8/arkitekt_next/apps/qt.py

@@ -0,0 +1,97 @@
+from arkitekt_next_next.model import Manifest
+from arkitekt_next_next.apps.types import QtApp
+from arkitekt_next_next.apps.fallbacks import ImportException, InstallModuleException
+from typing import Any, Optional
+
+
+def build_arkitekt_next_qt_app(
+    manifest: Manifest,
+    no_cache: bool = False,
+    instance_id: Optional[str] = None,
+    beacon_widget: Any = None,
+    login_widget: Any = None,
+    parent: Any = None,
+    settings: Any = None,
+):
+    try:
+        from koil.composition.qt import QtPedanticKoil
+        from qtpy import QtCore
+
+        settings = settings or QtCore.QSettings()
+    except ImportError as e:
+        raise InstallModuleException("Please install qtpy to use arkitekt_next_qt") from e
+
+    try:
+        from arkitekt_next_next.apps.service.fakts_qt import build_arkitekt_next_qt_fakts
+
+        fakts = build_arkitekt_next_qt_fakts(
+            manifest=manifest,
+            no_cache=no_cache,
+            beacon_widget=beacon_widget,
+            parent=parent,
+            settings=settings,
+        )
+    except ImportError as e:
+        fakts = ImportException(import_exception=e, install_library="qtpy")
+
+    try:
+        from arkitekt_next_next.apps.service.herre_qt import build_arkitekt_next_qt_herre
+
+        herre = build_arkitekt_next_qt_herre(
+            manifest=manifest,
+            fakts=fakts,
+            login_widget=login_widget,
+            parent=parent,
+            settings=settings,
+        )
+    except ImportError as e:
+        herre = ImportException(import_exception=e, install_library="qtpy")
+
+    try:
+        from arkitekt_next_next.apps.service.rekuest import build_arkitekt_next_rekuest
+
+        rekuest = build_arkitekt_next_rekuest(
+            fakts=fakts, herre=herre, instance_id=instance_id or "main"
+        )
+    except ImportError as e:
+        rekuest = ImportException(import_exception=e, install_library="rekuest")
+
+    try:
+        from arkitekt_next_next.apps.service.mikro import build_arkitekt_next_mikro
+
+        mikro = build_arkitekt_next_mikro(fakts=fakts, herre=herre)
+    except ImportError as e:
+        mikro = ImportException(import_exception=e, install_library="mikro")
+
+    try:
+        from arkitekt_next_next.apps.service.unlok import build_arkitekt_next_unlok
+
+        unlok = build_arkitekt_next_unlok(herre=herre, fakts=fakts)
+    except ImportError as e:
+        unlok = ImportException(import_exception=e, install_library="unlok")
+
+    try:
+        from arkitekt_next_next.apps.service.fluss import build_arkitekt_next_fluss
+
+        fluss = build_arkitekt_next_fluss(herre=herre, fakts=fakts)
+    except ImportError as e:
+        fluss = ImportException(import_exception=e, install_library="fluss")
+
+    try:
+        from arkitekt_next_next.apps.service.kluster import build_arkitekt_next_kluster
+
+        kluster = build_arkitekt_next_kluster(herre=herre, fakts=fakts)
+    except ImportError as e:
+        kluster = ImportException(import_exception=e, install_library="kluster")
+
+    return QtApp(
+        koil=QtPedanticKoil(parent=parent),
+        manifest=manifest,
+        fakts=fakts,
+        herre=herre,
+        rekuest=rekuest,
+        mikro=mikro,
+        unlok=unlok,
+        fluss=fluss,
+        kluster=kluster,
+    )

arkitekt_next-0.7.8/arkitekt_next/apps/service/__init__.py

@@ -0,0 +1,3 @@
+""" Modules for services, all services should be placed here.
+Services SHOULD not be used directly, but build through the
+builders in arkitekt_next/apps."""

arkitekt_next-0.7.8/arkitekt_next/apps/service/fakts.py

@@ -0,0 +1,88 @@
+from fakts.fakts import Fakts
+from fakts.fakts import Fakts
+from typing import Optional
+from fakts.grants.remote.discovery.well_known import WellKnownDiscovery
+from fakts.grants.remote import RemoteGrant
+from fakts.grants.remote.demanders.auto_save import AutoSaveDemander
+from fakts.grants.remote.demanders.cache import CacheTokenStore
+from fakts.grants.remote.demanders.static import StaticDemander
+from fakts.grants.remote.demanders.device_code import DeviceCodeDemander
+from fakts.grants.remote.claimers.post import ClaimEndpointClaimer
+from fakts.grants.remote.demanders.redeem import RedeemDemander
+from arkitekt_next_next.model import Manifest
+
+
+class ArkitektNextFaktsQt(Fakts):
+    grant: RemoteGrant
+
+
+class ArkitektNextFakts(Fakts):
+    pass
+
+
+def build_arkitekt_next_fakts(
+    manifest: Manifest,
+    url: Optional[str] = None,
+    no_cache: bool = False,
+    headless: bool = False,
+) -> ArkitektNextFakts:
+    identifier = manifest.identifier
+    version = manifest.version
+
+    if no_cache:
+        demander = DeviceCodeDemander(
+            manifest=manifest,
+            redirect_uri="http://127.0.0.1:6767",
+            open_browser=not headless,
+        )
+
+    else:
+        demander = AutoSaveDemander(
+            demander=DeviceCodeDemander(
+                manifest=manifest,
+                redirect_uri="http://127.0.0.1:6767",
+                open_browser=not headless,
+            ),
+            store=CacheTokenStore(
+                cache_file=f".arkitekt_next/cache/{identifier}-{version}_fakts_cache.json"
+            ),
+        )
+
+    return ArkitektNextFakts(
+        grant=RemoteGrant(
+            demander=demander,
+            discovery=WellKnownDiscovery(url=url, auto_protocols=["https", "http"]),
+            claimer=ClaimEndpointClaimer(),
+        )
+    )
+
+
+def build_arkitekt_next_token_fakts(
+    manifest: Manifest,
+    token: str,
+    url,
+    no_cache: Optional[bool] = False,
+    headless=False,
+):
+    return ArkitektNextFakts(
+        grant=RemoteGrant(
+            demander=StaticDemander(token=token),
+            discovery=WellKnownDiscovery(url=url, auto_protocols=["https", "http"]),
+            claimer=ClaimEndpointClaimer(),
+        )
+    )
+
+def build_arkitekt_next_redeem_fakts(
+    manifest: Manifest,
+    redeem_token: str,
+    url,
+    no_cache: Optional[bool] = False,
+    headless=False,
+):
+    return ArkitektNextFakts(
+        grant=RemoteGrant(
+            demander=RedeemDemander(token=redeem_token, manifest=manifest),
+            discovery=WellKnownDiscovery(url=url, auto_protocols=["https", "http"]),
+            claimer=ClaimEndpointClaimer(),
+        )
+    )