Skip to main content

client for the arkitekt_next platform

Project description

arkitekt_next

codecov PyPI version Maintenance Maintainer PyPI pyversions PyPI status

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)

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

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

arkitekt-next init

Which will lead you throught an app creation process. Apps can simply registered functions, through the register decorator

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:

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.

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.

def complex_call(x: ComplexStrucuture) -> int:
    return x.max()

Check out the arkitekt_next documentation for usage of this libary

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arkitekt_next-0.8.26.tar.gz (589.6 kB view details)

Uploaded Source

Built Distribution

arkitekt_next-0.8.26-py3-none-any.whl (635.9 kB view details)

Uploaded Python 3

File details

Details for the file arkitekt_next-0.8.26.tar.gz.

File metadata

  • Download URL: arkitekt_next-0.8.26.tar.gz
  • Upload date:
  • Size: 589.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Linux/6.8.0-47-generic

File hashes

Hashes for arkitekt_next-0.8.26.tar.gz
Algorithm Hash digest
SHA256 391138d3e0599a8cb907836799f59bf30fe3fe20b292b32b95b3e4ee185b143a
MD5 d24feb879e0fd0b68d613b631b3e40ee
BLAKE2b-256 e629c211a35bea81da2a951d8d32764dd3942d7a57d8ac0a71b58a987565c4cb

See more details on using hashes here.

File details

Details for the file arkitekt_next-0.8.26-py3-none-any.whl.

File metadata

  • Download URL: arkitekt_next-0.8.26-py3-none-any.whl
  • Upload date:
  • Size: 635.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.3 Linux/6.8.0-47-generic

File hashes

Hashes for arkitekt_next-0.8.26-py3-none-any.whl
Algorithm Hash digest
SHA256 fbf291973513bbc4aa7e2098148c4c75133d71b0ecf65143e2e500fefc6ecac2
MD5 22e9b1ba19d4bff931098d2ffabdce0f
BLAKE2b-256 b7e9b7eb05f0ed88ec2456f5f54a1499e31aa77c18e551f1be9905b03510a88e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page