pygomx/README.txt
saces ac6b878408
Some checks failed
Build, test and release / timestamp (push) Has been cancelled
Build, test and release / changes (push) Has been cancelled
Build, test and release / pygomx-wheel-mac (macos-14) (push) Has been cancelled
Build, test and release / pygomx-wheel-mac (macos-15-intel) (push) Has been cancelled
Build, test and release / pygomx-wheel-win (windows-11-arm) (push) Has been cancelled
Build, test and release / pygomx-wheel-win (windows-2022) (push) Has been cancelled
Build, test and release / pygomx-wheel-linux (ubuntu-24.04-arm) (push) Has been cancelled
Build, test and release / pygomx-wheel-linux (ubuntu-latest) (push) Has been cancelled
Build, test and release / pygomx-pypi (push) Has been cancelled
Build, test and release / smal-sdist (push) Has been cancelled
Build, test and release / smal-wheel (push) Has been cancelled
Build, test and release / smal-pypi (push) Has been cancelled
fix readme
2026-04-05 16:22:23 +02:00

69 lines
1.4 KiB
Text

monorepos to have the right versions together
libmxclient - golang matrix client library
pygomx - python binding package
smal - python matrix lib
just run the demobot (docker):
docker compose build demobot
docker compose run --rm demobot smalsetup <matrixid>
docker compose up -d demobot
the bot follows each invite (autojoin) and have two commands:
!stop - graceful shutdown
!echo [text] - in a DM the bot responds with 'text',
in regular rooms it is a reply.
binary/package install:
pip install pygomx
pip install mxsmal
install from source / develop (venv):
build configuration is done via env vars
# one of static, shared
PYGOMX_BUILD_MODE=static
# one of none, colm, goolm, vodozemac
PYGOMX_OLM_FLAVOR=goolm
# for colm you need libolm-dev installed
# vodozemac is not supported yet
you need go >=1.25 installed
(create and activate a venv)
cd pygomx
pip install .
cd ../mxsmal
pip install [-e] .
usage:
cd into an empty dir (you might create one)
smalsetup <matrixid>
this command creates a credentials file (.mxpass) in the current dir.
autopickup by all tools & bots that requires credentials, no further configuration required
commands:
mxdiscover --help
mxpassitem --help
mxwhoami --help
mxlogout --help
mxtoken
mxaccountinfo
mxclearaccount
mxserverinfo
demobot
matrix room:
#pygomx:matrix.org
https://matrix.to/#/#pygomx:matrix.org