Skip to main content
Pre-release

This release is a pre-release and may not be stable for production use.

DigitalKin Python SDK

CI PyPI Python Version License

The DigitalKin Python SDK for building and managing modules within the DigitalKin agentic mesh. Create custom Tools and Archetypes that communicate over gRPC, register with a service mesh, and scale independently.

Features

  • Async-native gRPC module system — every module is a gRPC server built on grpcio with full async support
  • Typed module contracts — Pydantic models for Input, Output, Setup, and Secret schemas with protocol-based trigger dispatch
  • Module-to-module communication — tools and archetypes discover each other via the registry and exchange requests over gRPC
  • Tool resolution — archetypes dynamically resolve and invoke tool modules at runtime
  • Admission queue & backpressure — built-in request admission with configurable concurrency limits
  • Healthcheck protocols — automatic ping, services, and status healthcheck triggers registered on every module
  • Profiling — optional [profiling] extra with asyncio-inspector, pyinstrument, viztracer, and yappi
  • Batched history writes — efficient storage writes for conversation history
  • Redis Streams — durable message passing, crash recovery, and reconnection

Installation

# With uv (recommended)
uv add digitalkin

# With pip
pip install digitalkin

Optional extras:

# Async profiling tools
uv add "digitalkin[profiling]"

# uvloop for faster event loop
uv add "digitalkin[performance]"

Quick Start

1. Define your models

from pydantic import BaseModel
from digitalkin.models.module.base_types import DataModel, DataTrigger


class MessageInput(DataTrigger):
    protocol: str = "message"
    content: str


class InputModel(DataModel[MessageInput]):
    root: MessageInput


class MessageOutput(DataTrigger):
    protocol: str = "message"
    reply: str


class OutputModel(DataModel[MessageOutput]):
    root: MessageOutput

2. Create a module and trigger

from digitalkin import ArchetypeModule, ModuleContext, TriggerHandler
from digitalkin.models.module.setup_types import SetupModel


class MyArchetype(ArchetypeModule[InputModel, OutputModel, SetupModel, BaseModel]):
    async def initialize(self, context: ModuleContext, setup_data: SetupModel) -> None:
        pass

    async def cleanup(self, context: ModuleContext) -> None:
        pass


@MyArchetype.register
class MessageTrigger(TriggerHandler[InputModel, SetupModel, OutputModel]):
    protocol = "message"
    input_format = InputModel
    output_format = OutputModel

    def __init__(self, context: ModuleContext) -> None:
        super().__init__(context)

    async def handle(
        self,
        input_data: InputModel,
        setup_data: SetupModel,
        context: ModuleContext,
    ) -> None:
        output = OutputModel(root=MessageOutput(reply=f"Echo: {input_data.root.content}"))
        await self.send_message(context, output)

3. Run the server

import asyncio
from digitalkin.grpc_servers.module_server import ModuleServer

async def main() -> None:
    server = ModuleServer(MyArchetype)
    await server.start_async()
    await server.await_termination()

asyncio.run(main())

Redis Gateway

The embedded gateway enables real-time bidirectional communication between modules via Redis Streams, with crash recovery and horizontal scaling.

  • Durable Streaming: Output persisted to Redis Streams — reconnection via from_seq.
  • Zero-Copy Proto: Binary proto serialization to Redis — no JSON intermediary.
  • Horizontal Scaling: Each module instance embeds its own gateway. Scale by adding replicas behind a load balancer.

Development

Prerequisites

  • Python 3.10+
  • uv — modern Python package management
  • Task — task runner

Setup

git clone --recurse-submodules https://github.com/DigitalKin-ai/digitalkin.git
cd digitalkin

task setup-dev
source .venv/bin/activate

Common Tasks

task linter               # Format + lint (ruff) + type check (mypy)
task check                # Linter + mypy + tests
task run-tests            # Run pytest via Docker
task build-package        # Build distribution
task bump-version -- patch|minor|major

task docs-serve           # Serve docs locally (mkdocs)
task docs-build           # Build docs

task generate-certificates  # Generate mTLS certs for gRPC
task clean                # Remove build artifacts + __pycache__
task clean-all            # Above + remove .venv

Publishing Process

  1. Update code and commit changes (following conventional branch/commit standard).
  2. Use task bump-version -- major|minor|patch to commit the new version.
  3. Use GitHub "Create Release" workflow to publish the new version.
  4. Workflow automatically publishes to Test PyPI and PyPI.

License

This project is licensed under the terms specified in the LICENSE file.


For more information, visit our Documentation or report issues on our Issues page.

Download files

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

Source Distribution

digitalkin-1.0.2.dev5.tar.gz (275.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

digitalkin-1.0.2.dev5-py3-none-any.whl (371.3 kB view details)

Uploaded Python 3

File details

Details for the file digitalkin-1.0.2.dev5.tar.gz.

File metadata

  • Download URL: digitalkin-1.0.2.dev5.tar.gz
  • Upload date:
  • Size: 275.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for digitalkin-1.0.2.dev5.tar.gz
Algorithm Hash digest
SHA256 dc19afb33d106522bb5c8896390600e3f1644354a775f08228c9d31c2b4cce47
MD5 ee3c27d21c0b063983379c9480a13bc0
BLAKE2b-256 c0c95463c02c15579438b5ff2b8028678b8959241b9270e9b8f5470e422df2d9

See more details on using hashes here.

Provenance

The following attestation bundles were made for digitalkin-1.0.2.dev5.tar.gz:

Publisher: release.yml on DigitalKin-ai/digitalkin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file digitalkin-1.0.2.dev5-py3-none-any.whl.

File metadata

  • Download URL: digitalkin-1.0.2.dev5-py3-none-any.whl
  • Upload date:
  • Size: 371.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for digitalkin-1.0.2.dev5-py3-none-any.whl
Algorithm Hash digest
SHA256 f9e25ce315e26601af30af31b21d57c2281e9daa6704bb261b2df22fee31d4ba
MD5 869a62d0311ceb65e12b997335ec8be6
BLAKE2b-256 c8f29b925d840e20736a42c666d4cd293e19174c891f7823dd860fd8718ed6dc

See more details on using hashes here.

Provenance

The following attestation bundles were made for digitalkin-1.0.2.dev5-py3-none-any.whl:

Publisher: release.yml on DigitalKin-ai/digitalkin

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

1.0.3

2 files

1.0.2

2 files

This release

1.0.2.dev5 This release

2 files

1.0.0

2 files

0.4.5

2 files

0.4.4

2 files

0.4.3

2 files

0.4.2

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2.post0

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.26

2 files

0.2.25

2 files

0.2.24

2 files

0.2.23

2 files

0.2.22

2 files

0.2.21

2 files

0.2.20

2 files

0.2.19

2 files

0.2.18

2 files

0.2.17

2 files

0.2.16

2 files

0.2.15

2 files

0.2.14

2 files

0.2.13

2 files

0.2.12

2 files

0.2.11

2 files

0.2.10

2 files

0.2.9

2 files

0.2.8

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page