swarmauri_state_clipboard 0.11.0.dev1

Clipboard-backed Swarmauri state provider for transient desktop workflows and local automation.

Swarmauri State Clipboard

swarmauri_state_clipboard provides a Swarmauri StateBase implementation that stores state in the system clipboard. It is useful for desktop prototyping, local demos, quick workflow handoffs, and lightweight human-in-the-loop tooling where a full database or cache would be unnecessary.

Why Use Swarmauri State Clipboard

• Persist small state payloads without adding external infrastructure.
• Bridge state between local tools, notebooks, shells, and GUI apps.
• Prototype Swarmauri stateful flows quickly on Windows, macOS, or Linux.
• Keep local development loops simple when you only need transient state.

FAQ

What does this package store?
It stores dictionary-shaped data by serializing it to the system clipboard.

Which platforms are supported?
Windows uses clip and PowerShell Get-Clipboard, macOS uses pbcopy and pbpaste, and Linux uses xclip.

Is this suitable for production workloads?
Usually no. The clipboard is global, user-facing, and not designed for secure or concurrent application state.

How is clipboard data parsed when reading?
The package uses ast.literal_eval to parse string content into Python literals.

Features

• Swarmauri StateBase implementation registered as ClipboardState.
• Cross-platform clipboard access through built-in OS utilities.
• Read, write, update, reset, and deep-copy state helpers.
• No third-party runtime dependency beyond core Swarmauri packages.
• Supports Python 3.10, 3.11, 3.12, 3.13, and 3.14.

Installation

uv add swarmauri_state_clipboard

pip install swarmauri_state_clipboard

Usage

from swarmauri_state_clipboard import ClipboardState

state = ClipboardState()
state.write({"session": "abc123", "step": 1})

print(state.read())

state.update({"step": 2})
print(state.read())

Examples

Use clipboard state in a local prototype

from swarmauri_state_clipboard import ClipboardState

state = ClipboardState()
state.write({"draft": "ready", "owner": "local-user"})

print(state.read())

Reset state after a task completes

from swarmauri_state_clipboard import ClipboardState

state = ClipboardState()
state.write({"job": "complete"})
state.reset()

print(state.read())  # {}

Clone the current state for a second workflow branch

from swarmauri_state_clipboard import ClipboardState

state = ClipboardState()
state.write({"request_id": "req-001", "status": "queued"})

forked_state = state.deep_copy()
forked_state.update({"status": "processed"})

print(state.read())
print(forked_state.read())

Related Packages

• swarmauri
• swarmauri_standard
• swarmauri_workflow_statedriven

Swarmauri Foundations

• swarmauri_core
• swarmauri_base

More Documentation

• Swarmauri SDK repository
• Python ast.literal_eval documentation

Best Practices

• Keep clipboard payloads small and short-lived.
• Avoid storing secrets or sensitive tokens in clipboard-backed state.
• Install xclip explicitly on Linux hosts and CI runners.
• Prefer a durable state backend for concurrent, remote, or production flows.

License

This project is licensed under the Apache-2.0 License.