Skip to main content

Canon messaging platform plugin for Hermes Agent (canon-bridge backed)

Project description

Canon Hermes Plugin

Canon messaging platform plugin for Hermes Agent, built on the local canon-bridge daemon: the plugin is a thin canon-framework consumer, and every Canon wire concern (REST, SSE delivery, RTDB planes, durable HITL, media) lives in the bridge process the plugin spawns.

Install

pip install canon-hermes-plugin
canon-hermes install --setup

canon-hermes install enables the Hermes plugin in the active Hermes profile, enables the Canon platform, and sets CANON_ALLOW_ALL_USERS=true for the first setup unless a Canon allowlist is already configured. Add --setup to immediately register or reconnect a Canon agent profile. If console scripts are not on PATH, use python -m canon_hermes_plugin.cli install --setup instead. Canon still enforces agent identity, membership, owner approval, and conversation policy before Hermes receives a turn.

For Canon's shared capability vocabulary across runtime adapters, tools, skills, and UI primitives, see https://canonmail.com/agents/integration-capability-manifest.

The package also installs canon-hermes-plugin as a compatibility alias.

Runtime requirement: Node (not npm)

The wheel bundles the canon-bridge JS as package data (canon_hermes_plugin/_bridge/…, produced by scripts/bundle_bridge.mjs). At runtime the plugin spawns it as a managed child over stdio — the bridge dies with the gateway process; nothing daemonizes.

  • Container images (Railway-style) need Node ≥ 20 in the image — npm is NOT required. A couple of Dockerfile lines, e.g.:

    COPY --from=node:22-slim /usr/local/bin/node /usr/local/bin/node
    
  • Bridge resolution order (canon-framework): $CANON_BRIDGE_BIN → the wheel-bundled dist → repo dev checkout (packages/bridge/dist) → canon-bridge on PATH~/.canon/bin/canon-bridge.

  • Knobs: CANON_BRIDGE_MODE (auto | connect | managed-child), CANON_BRIDGE_BIN, CANON_BRIDGE_NODE.

  • canon-hermes doctor reports the resolved Node + bridge entry.

Development

cd adapters/hermes-plugin
node scripts/bundle_bridge.mjs        # embed the bridge dist (also run before publishing)
uv run --with pytest --with-editable . pytest tests -q

In a monorepo checkout the bundle step is optional for tests — the plugin falls back to the repo-relative packages/bridge/dist build. uv resolves canon-framework from packages/framework-py via [tool.uv.sources]; published wheels depend on the PyPI canon-framework release instead.

The plugin does not require a public webhook server and does not require npm at runtime.

Project details


Download files

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

Source Distribution

canon_hermes_plugin-0.2.2.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

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

canon_hermes_plugin-0.2.2-py3-none-any.whl (1.7 MB view details)

Uploaded Python 3

File details

Details for the file canon_hermes_plugin-0.2.2.tar.gz.

File metadata

  • Download URL: canon_hermes_plugin-0.2.2.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.12

File hashes

Hashes for canon_hermes_plugin-0.2.2.tar.gz
Algorithm Hash digest
SHA256 0ced9c9d6af5de4e50d789b5876b195d8d07099d61e4699a260c3d4120418fc3
MD5 1ba67b081c7a6b14831c843669d43818
BLAKE2b-256 41061a9565eb0a8773a56918fb991a54ee2adbb5110d0102a6fffc6754cf0ff3

See more details on using hashes here.

File details

Details for the file canon_hermes_plugin-0.2.2-py3-none-any.whl.

File metadata

File hashes

Hashes for canon_hermes_plugin-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 10adaf3c34755a34a1ba6a03b046b80d7b2b81af11a30fa0c3c38f78e30c0d18
MD5 0cee110caead4192a7acde7b0e536650
BLAKE2b-256 e979174fad8b4c3873e6d67f7c4a960d8d0ece41663d09d332df6cb5ccca9686

See more details on using hashes here.

Supported by

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