Metadata-Version: 2.4
Name: openparallax-channels
Version: 0.1.1
Summary: Python wrapper for the OpenParallax channels module
Project-URL: Documentation, https://docs.openparallax.dev/channels/python
Project-URL: Repository, https://github.com/openparallax/openparallax
License-Expression: Apache-2.0
Keywords: ai-agent,channels,messaging,openparallax
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# openparallax-channels

Multi-channel messaging adapters (WhatsApp, Telegram, Discord, Signal, iMessage)

Python wrapper for the [OpenParallax](https://docs.openparallax.dev) channels module. Communicates with a pre-built Go binary over JSON-RPC (stdin/stdout).

## Installation

```bash
pip install openparallax-channels
```

## Usage

```python
from openparallax_channels import Channels

with Channels() as ch:
    # Split a long message into platform-safe chunks
    parts = ch.split_message(long_text, max_length=2000)

    # Format a message (0=plain, 1=markdown, 2=HTML)
    msg = ch.format_message("Hello!", format=1)
```

## Passing Channel Credentials

Channel credentials (bot tokens, API keys, webhook URLs) are passed through OpenParallax's workspace `config.yaml`, not through this wrapper directly. The wrapper communicates with the Go channels-bridge binary, which reads credentials from the workspace config.

Configure channels in your workspace `config.yaml`:

```yaml
channels:
  telegram:
    enabled: true
    bot_token_env: TELEGRAM_BOT_TOKEN
  discord:
    enabled: true
    bot_token_env: DISCORD_BOT_TOKEN
  slack:
    enabled: true
    bot_token_env: SLACK_BOT_TOKEN
    app_token_env: SLACK_APP_TOKEN
```

### Telegram Example

```bash
export TELEGRAM_BOT_TOKEN="123456:ABC-DEF..."
```

```yaml
# config.yaml
channels:
  telegram:
    enabled: true
    bot_token_env: TELEGRAM_BOT_TOKEN
```

```python
from openparallax_channels import Channels

with Channels() as ch:
    parts = ch.split_message(response_text, max_length=4096)
    for part in parts:
        send_to_telegram(chat_id, part)
```

## Documentation

See the [channels documentation](https://docs.openparallax.dev/channels/) for all supported platforms and configuration options.

## License

Apache License 2.0
