Metadata-Version: 2.4
Name: takopi-matrix
Version: 0.4.0
Summary: Matrix transport backend for Takopi
Project-URL: Homepage, https://github.com/Zorro909/takopi-matrix
Project-URL: Repository, https://github.com/Zorro909/takopi-matrix
Project-URL: Issues, https://github.com/Zorro909/takopi-matrix/issues
License: MIT License
        
        Copyright (c) 2025
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.14
Requires-Dist: anyio>=4.12.0
Requires-Dist: httpx>=0.28.1
Requires-Dist: markdown-it-py
Requires-Dist: matrix-nio[e2e]>=0.24
Requires-Dist: pydantic-settings>=2.12.0
Requires-Dist: pydantic>=2.12.5
Requires-Dist: questionary>=2.1.1
Requires-Dist: rich>=14.2.0
Requires-Dist: structlog>=25.5.0
Requires-Dist: takopi>=0.20.0
Requires-Dist: tomli-w>=1.2.0
Requires-Dist: tomlkit>=0.13.0
Description-Content-Type: text/markdown

# 🐙 takopi-matrix

Matrix transport backend for [takopi](https://github.com/banteg/takopi).

## Features

- Matrix protocol support via [matrix-nio](https://github.com/matrix-nio/matrix-nio)
- End-to-end encryption (E2EE) by default
- Voice message transcription (OpenAI Whisper)
- File download support
- Interactive onboarding wizard
- Multi-room support with per-room engine defaults
- Project-to-room binding

## Requirements

- Python ≥3.14
- [libolm](https://gitlab.matrix.org/matrix-org/olm) 3.x (for E2EE)
- takopi ≥0.18

## Installation

### 1. Install libolm

| Platform | Command |
|----------|---------|
| Debian/Ubuntu | `sudo apt-get install libolm-dev` |
| Fedora | `sudo dnf install libolm-devel` |
| Arch Linux | `sudo pacman -S libolm` |
| openSUSE | `sudo zypper install libolm-devel` |
| macOS (Homebrew) | `brew install libolm` |

### 2. Install takopi-matrix

```bash
pip install takopi-matrix
```

Or with uv:

```bash
uv tool install takopi --with takopi-matrix
```

## Configuration

### Interactive Setup

```bash
takopi --onboard
```

### Manual Configuration

Add to `~/.takopi/takopi.toml`:

```toml
transport = "matrix"

[transports.matrix]
homeserver = "https://matrix.example.org"
user_id = "@bot:example.org"
access_token = "syt_your_access_token"
room_ids = ["!roomid:example.org"]

# Optional: per-room engine defaults
[transports.matrix.room_engines]
"!room1:example.org" = "claude"
"!room2:example.org" = "codex"

# Optional: project-to-room binding
[transports.matrix.room_projects]
"!room1:example.org" = "myproject"
```

## Documentation

- [Matrix Transport Reference](docs/matrix.md) - Full configuration options
- [Architecture Overview](docs/architecture/overview.md) - System design
- [Development Setup](docs/development/setup.md) - Contributing guide

## License

MIT
