arkitekt-next 0.31.0__tar.gz

arkitekt_next-0.31.0/.gitignore

@@ -0,0 +1,148 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+**/__pycache__
+*.py[cod]
+*$py.class
+*.pyc
+*.DS_Store
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# static files generated from Django application using `collectstatic`
+media
+export
+static_collected
+data
+token.temp

arkitekt_next-0.31.0/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.31.0/PKG-INFO

@@ -0,0 +1,175 @@
+Metadata-Version: 2.4
+Name: arkitekt-next
+Version: 0.31.0
+Summary: client for the arkitekt_next platform
+Author-email: jhnnsrs <jhnnsrs@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: <4,>=3.11
+Requires-Dist: click>=8.2.0
+Requires-Dist: dokker>=2.3.0
+Requires-Dist: fakts-next>=2.3.0
+Requires-Dist: kabinet>=0.9.0
+Requires-Dist: koil>=2.0.6
+Requires-Dist: platformdirs>=4.5.0
+Requires-Dist: rath>=3.7.0
+Requires-Dist: rekuest-next>=0.18.3
+Requires-Dist: rich-click>=1.8.8
+Requires-Dist: semver>=3.0.4
+Requires-Dist: turms>=0.10.1
+Requires-Dist: watchfiles>=1.0.5
+Provides-Extra: all
+Requires-Dist: fluss-next>=0.2.0; extra == 'all'
+Requires-Dist: kabinet>=0.6.0; extra == 'all'
+Requires-Dist: mikro-next>=0.7.2; extra == 'all'
+Requires-Dist: reaktion-next>=0.2.0; extra == 'all'
+Requires-Dist: rekuest-next>=0.7; extra == 'all'
+Requires-Dist: rich-click>=1.6.1; extra == 'all'
+Requires-Dist: semver>=3.0.1; extra == 'all'
+Requires-Dist: turms>=0.9; extra == 'all'
+Requires-Dist: unlok-next>=1.1.1; extra == 'all'
+Requires-Dist: watchfiles>=0.18.1; extra == 'all'
+Provides-Extra: alpaka
+Requires-Dist: alpaka>=0.2.0; extra == 'alpaka'
+Provides-Extra: blok
+Requires-Dist: blok>=0.1.0; extra == 'blok'
+Provides-Extra: cli
+Requires-Dist: turms>=0.9.0; extra == 'cli'
+Provides-Extra: elektro
+Requires-Dist: elektro>=0.5.0; extra == 'elektro'
+Provides-Extra: extended
+Requires-Dist: alpaka>=0.2.0; extra == 'extended'
+Requires-Dist: kraph>=0.2.0; extra == 'extended'
+Provides-Extra: fluss
+Requires-Dist: fluss-next>=0.2.0; extra == 'fluss'
+Provides-Extra: kabinet
+Requires-Dist: kabinet>=0.6.0; extra == 'kabinet'
+Provides-Extra: kraph
+Requires-Dist: kraph>=0.2.0; extra == 'kraph'
+Provides-Extra: lovekit
+Requires-Dist: lovekit>=0.2.0; extra == 'lovekit'
+Provides-Extra: mikro
+Requires-Dist: mikro-next>=0.7.2; extra == 'mikro'
+Provides-Extra: reaktion
+Requires-Dist: reaktion-next>=0.2.0; extra == 'reaktion'
+Provides-Extra: unlok
+Requires-Dist: unlok-next>=1.1.1; extra == 'unlok'
+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.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.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.live) for usage of this libary

arkitekt_next-0.31.0/README.md

@@ -0,0 +1,117 @@
+# 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.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.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.live) for usage of this libary

arkitekt_next-0.31.0/arkitekt_next/__init__.py

@@ -0,0 +1,108 @@
+from .builders import easy, interactive
+from .app.app import App
+from fakts_next.helpers import afakt, fakt
+from .init_registry import init, InitHookRegistry, get_default_init_hook_registry
+from .service_registry import (
+    require,
+    ServiceBuilderRegistry,
+    get_default_service_registry,
+)
+
+
+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.background import background
+    from rekuest_next.agents.hooks.startup import startup
+    from rekuest_next.agents.context import context
+    from rekuest_next.state.decorator import state
+    from rekuest_next.actors.context import abreakpoint, breakpoint
+    from rekuest_next.actors.context import progress, aprogress
+    from rekuest_next.actors.context import log, alog
+    from rekuest_next.structures.model import model
+    from rekuest_next.actors.context import apublish, publish
+    from rekuest_next.remote import (
+        call,
+        acall,
+        acall_raw,
+        iterate,
+        aiterate,
+        aiterate_raw,
+        find,
+    )
+    from rekuest_next.declare import declare, protocol
+    from .inspect import inspect
+except ImportError as e:
+    raise e
+    inspect = missing_install("rekuest_next", e)
+    publish = missing_install("rekuest_next", e)
+    apublish = missing_install("rekuest_next", e)
+    structure = missing_install("rekuest_next", e)
+    register = missing_install("rekuest_next", e)
+    declare = missing_install("rekuest_next", e)
+    protocol = missing_install("rekuest_next", e)
+    background = missing_install("rekuest_next", e)
+    abreakpoint = missing_install("rekuest_next", e)
+    breakpoint = missing_install("rekuest_next", e)
+    startup = missing_install("rekuest_next", e)
+    context = missing_install("rekuest_next", e)
+    find = missing_install("rekuest_next", e)
+    state = missing_install("rekuest_next", e)
+    progress = missing_install("rekuest_next", e)
+    aprogress = missing_install("rekuest_next", e)
+    log = missing_install("rekuest_next", e)
+    alog = missing_install("rekuest_next", e)
+    call = missing_install("rekuest_next", e)
+    call_raw = missing_install("rekuest_next", e)
+    acall = missing_install("rekuest_next", e)
+    acall_raw = missing_install("rekuest_next", e)
+    find = missing_install("rekuest_next", e)
+    afind = missing_install("rekuest_next", e)
+    aiterate_raw = missing_install("rekuest_next", e)
+    aiterate = missing_install("rekuest_next", e)
+    iterate = missing_install("rekuest_next", e)
+
+
+__all__ = [
+    "App",
+    "require",
+    "easy",
+    "interactive",
+    "log",
+    "alog",
+    "afakt",
+    "fakt",
+    "progress",
+    "InitHookRegistry",
+    "get_default_init_hook_registry",
+    "aprogress",
+    "ServiceBuilderRegistry",
+    "get_default_service_registry",
+    "register",
+    "find",
+    "breakpoint",
+    "abreakpoint",
+    "aiterate",
+    "inspect",
+    "iterate",
+    "aiterate_raw",
+    "call",
+    "acall",
+    "acall_raw",
+    "model",
+    "state",
+    "context",
+    "background",
+    "startup",
+    "init",
+    "InitHookRegisty",
+    "get_current_init_hook_registry",
+]

arkitekt_next-0.31.0/arkitekt_next/app/__init__.py

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

arkitekt_next-0.31.0/arkitekt_next/app/app.py

@@ -0,0 +1,73 @@
+"""
+This module contains the types for the apps
+depending on the builder used.
+This module imports all the apps and their types
+and sets them as attributes on the App class, if they are available.
+If they are not available, they are set to Any, so that we can add
+an import exception to the app.
+
+
+"""
+
+import logging
+from typing import Any, Dict, TYPE_CHECKING
+from koil import unkoil
+from koil.composition import Composition
+from fakts_next import Fakts
+
+
+if TYPE_CHECKING:
+    from rekuest_next.rekuest import RekuestNext
+
+
+logger = logging.getLogger(__name__)
+
+
+class App(Composition):
+    """An app that is built with the easy builder"""
+
+    fakts: Fakts
+    services: Dict[str, Any]
+
+    @property
+    def rekuest(self) -> "RekuestNext":
+        """Get the rekuest service"""
+        if "rekuest" not in self.services:
+            raise ValueError("Rekuest service is not available")
+        return self.services["rekuest"]
+
+    def run(self):
+        """Run the app by calling rekuest.run()"""
+        return unkoil(self.rekuest.arun)
+
+    async def arun(self):
+        """Run the app asynchronously"""
+        return await self.rekuest.arun()
+
+    def run_detached(self):
+        """Run the app detached"""
+        return self.rekuest.run_detached()
+
+    def register(self, *args, **kwargs):
+        """Register a service"""
+
+        self.rekuest.register(*args, **kwargs)
+
+    def register_startup(self, *args, **kwargs):
+        """Register a startup service"""
+        self.rekuest.register_startup(*args, **kwargs)
+
+    def register_background(self, *args, **kwargs):
+        """Register a background service"""
+        self.rekuest.register_background(*args, **kwargs)
+
+    async def __aenter__(self):
+        await super().__aenter__()
+        for service in self.services.values():
+            await service.__aenter__()
+
+        return self
+
+    async def __aexit__(self, exc_type, exc_value, traceback):
+        for service in self.services.values():
+            await service.__aexit__(exc_type, exc_value, traceback)