Matrix.py is a lightweight and intuitive Python library to build bots on the Matrix protocol. It provides a clean, decorator-based API similar to popular event-driven frameworks, allowing developers to focus on behavior rather than boilerplate.
- Minimal setup — install and have a working bot running in minutes
- Event-driven — async/await API reacting to any Matrix room event
- Command system — decorator-based commands with automatic argument parsing
- Extensions — split your bot into modules as it grows
Quickstart
Requirements: Python 3.10+
pip install matrix-python
Using a virtual environment is strongly recommended:
python -m venv venv
source venv/bin/activate # Windows: venv\Scripts\activate
pip install matrix-python
Create a config.yml:
USERNAME: "@yourbot:matrix.org"
PASSWORD: "your_password"
from matrix import Bot, Context
bot = Bot()
@bot.command("ping")
async def ping(ctx: Context):
await ctx.reply("Pong!")
bot.start(config="config.yml")
Send !ping in any room the bot is in, it will reply Pong!.
Where to go next
- Guides — step-by-step tutorials covering commands, events, checks, extensions, and more
- Reference — complete API documentation for every class and function
- Examples — ready-to-run example bots demonstrating common patterns
Contributing
We welcome everyone to contribute! Whether it's fixing bugs, suggesting features, or improving the docs. Every bit helps.
- Submit an issue
- Open a pull request
- Hop into our Matrix or Discord and say hi!
Please read the CONTRIBUTING.md and follow the code of conduct.
License
Released under the MIT License.
Metadata
Release files for matrix-python 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| matrix_python-1.0.1.tar.gz | 96.2 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| matrix_python-1.0.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 136.1 kB
Release files / matrix_python-1.0.1.tar.gz
| Download URL | matrix_python-1.0.1.tar.gz |
|---|---|
| Size | 96.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
00e4ce904f60735a4c91ca734d60c4e2193d73ef50bbe4ca3b27f94e7fcbf08b
|
|
BLAKE2b-256 checksum How to use checksums |
2a73f7b5554f06228e1750374969ad13d66d7b4d986174f2d3667d4e02a9bfd2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 4, 2026.
Transparency logRelease files / matrix_python-1.0.1-py3-none-any.whl
| Download URL | matrix_python-1.0.1-py3-none-any.whl |
|---|---|
| Size | 39.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a1518684ab04bae416f91e46a527847a90583bfb9486008cdb83977790a44053
|
|
BLAKE2b-256 checksum How to use checksums |
b2a705a0a077a13a90703c30bfcddd668f0929500830f186685551ae83a8c3d6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 4, 2026.
Transparency logSecurity for matrix-python 1.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for matrix_python-1.0.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 4, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
