Registry / communication / matrix-synapse

matrix-synapse

library1.155.0pypypi✓ verified 84d ago

Synapse is the reference homeserver for the Matrix decentralized communication protocol. As of version 1.152.0, it requires Python 3.10+ and follows a rapid release cadence. This package provides the server backend, not a client library.

communication

pip install matrix-synapse

github ↗package ↗homepage ↗docs ↗

INSTALL

IMPORT

SIG · MATRIX-SYNAPSE

matrix-synapse

communicationpythonv1.155.0

Install

16.6s avg

Import

755ms

Disk

224MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.155.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.762s · 247.2MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 16.6s · import 0.748s · 248MB

224MB installed

● package 224MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

synapse module

✓ import synapse

Synapse is a server package, not typically imported as a library. Use 'import synapse' only for internal modules.

Synapse is a server; quickstart shows how to generate config and run.

# Synapse is a server application, not a library for direct import. # To run it, use the command line: # python -m synapse.app.homeserver --server-name my.domain --config-path homeserver.yaml --generate-config # For development, install and then start: # install via pip, then run: # synctl start print('Synapse is a server; see https://matrix-org.github.io/synapse/latest/')

synapse --version

Debug

Known issues

breakingSynapse 1.96 dropped support for Python 3.7 and 3.8; 1.110 dropped Python 3.9. Upgrade to Python 3.10+.

fix

Ensure your environment uses Python 3.10 or later.

affects: >=1.96

gotchaDo not pip install matrix-synapse expecting a client library. Synapse is a server. For Python clients, use matrix-nio or matrix-client.

fix

Use matrix-nio for client SDK: pip install matrix-nio

affects: all

breakingConfiguration format changes between major versions; old config files may break. Especially the transition to YAML-only and removal of legacy options.

fix

Review upgrade notes at https://matrix-org.github.io/synapse/latest/upgrade.html

affects: >=1.0

Errors

Common errors & fixes

ImportError: cannot import name 'MatrixClient' from 'matrix_client'

Confusion between server package and client library. matrix-synapse does not provide a MatrixClient.

fix

Use matrix-nio: pip install matrix-nio; from nio import AsyncClient

synapse module not found or python: can't open file 'synctl': [Errno 2] No such file or directory

synctl is not installed as a script; must be run from the source tree or use python -m synapse.app.homeserver.

fix

Run: python -m synapse.app.homeserver --server-name my.domain --config-path homeserver.yaml --generate-config

Upgrade

Version history

1.155.0latest on PyPI · released Jun 16, 2026

Audit

Dependencies

No dependency data recorded yet.

Agent activity

22 hits · last 30 days

node

Amazon

OpenAI (training)

Resources

githubhttps://github.com/element-hq/synapse ↗

packagehttps://pypi.org/project/matrix-synapse/ ↗

homepagehttps://matrix.org ↗

docshttps://element-hq.github.io/synapse/latest ↗