Skip to main content

A matrix bot named Bob

Project description

Matrix BOB

A Matrix bot to experiment with autoregressive LLMs.
Bob integrates with any OpenAI-compatible API (e.g. Ollama, LiteLLM) and can:

  • carry on conversations in Matrix rooms
  • transcribe audio messages and use them as input
  • describe and process images
  • scrape the web and summarize content

Install

python -m venv .venv
source .venv/bin/activate
pip install .

Development

pip install --editable .

Configuration

Copy the sample config and fill in your values:

cp config/sample.config.yaml config/config.yaml

Minimum fields to set: Matrix credentials (user_id, user_password, homeserver_url, device_id), inviters, power_users, and the openai.url pointing at your LLM backend.

Run

Bob requires a PostgreSQL database. The docker/ directory contains a docker-compose.yaml that starts the database and the bot together:

cd docker
docker compose up -d

Or run locally after starting PostgreSQL separately:

bob [config/config.yaml]

Config file defaults to config/config.yaml.

Database migrations

alembic upgrade head

Run this once on first setup and after any update that includes new migrations.

Deployment

See docs/deployment.md for a full production deployment guide (Docker Compose + systemd + GitHub Actions CI).

Open source and contributing

Contributions are welcome — please open an issue or discussion before starting significant work. See CONTRIBUTING.md for guidelines.

Thanks to

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

pawnai_matrix-0.3.0.tar.gz (185.3 kB view details)

Uploaded Source

Built Distribution

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

pawnai_matrix-0.3.0-py3-none-any.whl (89.1 kB view details)

Uploaded Python 3

File details

Details for the file pawnai_matrix-0.3.0.tar.gz.

File metadata

  • Download URL: pawnai_matrix-0.3.0.tar.gz
  • Upload date:
  • Size: 185.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pawnai_matrix-0.3.0.tar.gz
Algorithm Hash digest
SHA256 1801be30ce703878ebd6c1e5cadc8176103f41df707f5e220bed3e0788c78726
MD5 0a3c5be591f55d8ab507d770237aa9d6
BLAKE2b-256 46ea374f859f8c3a575c53e178c9a0b111918b2fbc1e8ad018198737d4899986

See more details on using hashes here.

Provenance

The following attestation bundles were made for pawnai_matrix-0.3.0.tar.gz:

Publisher: publish.yml on codref/pawnai-matrix

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pawnai_matrix-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: pawnai_matrix-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 89.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for pawnai_matrix-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7c4f2cc086f9e05d444a19244b2b9ab5d44e48db9d0e57cfec4371b855e0ac66
MD5 d33b30ad07f4fda248fd618f998006c7
BLAKE2b-256 a7a1058abedbf1bebeb2815a86b86be41bd4f20b9e90456c3d4d061ada21c599

See more details on using hashes here.

Provenance

The following attestation bundles were made for pawnai_matrix-0.3.0-py3-none-any.whl:

Publisher: publish.yml on codref/pawnai-matrix

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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