swarmauri_state_clipboard 0.8.3.dev18

Swarmauri Community Clipboard State

---

Swarmauri State Clipboard

ClipboardState implements Swarmauri's StateBase interface using the system clipboard as storage. Useful for quick demos or sharing state between desktop tools without running an external datastore.

Features

• Reads/writes clipboard contents via platform commands (clip, pbcopy/pbpaste, xclip).
• Stores JSON-like dictionaries as string representations; uses ast.literal_eval when reading.
• Provides write, read, update, reset, and deep_copy helpers.

Prerequisites

• Python 3.10 or newer.
• OS clipboard utilities available:
  • Windows: clip (built-in) and PowerShell Get-Clipboard.
  • macOS: pbcopy/pbpaste (built-in).
  • Linux: xclip installed (apt install xclip or equivalent).

Installation

# pip
pip install swarmauri_state_clipboard

# poetry
poetry add swarmauri_state_clipboard

# uv (pyproject-based projects)
uv add swarmauri_state_clipboard

Quickstart

from swarmauri_state_clipboard import ClipboardState

state = ClipboardState()
state.write({"key1": "value1", "counter": 42})
print(state.read())

state.update({"counter": 43})
print(state.read())

state.reset()
print(state.read())  # {}

Deep Copy

state = ClipboardState()
state.write({"session": "abc123"})
clone = state.deep_copy()
clone.update({"session": "xyz789"})

print(state.read())   # {'session': 'abc123'}
print(clone.read())    # {'session': 'xyz789'}

Tips

• Clipboard overwrites are global; avoid using this state provider in multi-user or production environments where clipboard privacy matters.
• Contents are stored as Python literal strings—avoid writing untrusted data to the clipboard to prevent evaluation issues (though ast.literal_eval mitigates code execution risks).
• Ensure required system commands exist before running in CI or containers (install xclip for Linux builds).

Want to help?

If you want to contribute to swarmauri-sdk, read up on our guidelines for contributing that will help you get started.