pygomx/README.txt

52 lines
1.1 KiB
Text
Raw Normal View History

2026-01-12 17:39:34 +01:00
monorepos to have the right versions together
libmxclient - golang matrix client library
2026-02-10 14:49:35 +01:00
pygomx-module - python binding package
2026-01-12 17:39:34 +01:00
smal - python matrix lib
2026-02-10 14:49:35 +01:00
just run the demobot (docker):
2026-01-31 08:13:53 +01:00
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:
2026-02-10 14:49:35 +01:00
!stop - graceful shutdown
!echo [text] - in a DM the bot responds with 'text',
in regular rooms it is a reply.
2026-01-31 08:13:53 +01:00
2026-02-10 14:49:35 +01:00
install (venv):
2026-01-31 08:13:53 +01:00
2026-02-10 14:49:35 +01:00
(create and activate a venv)
2026-01-31 08:13:53 +01:00
2026-02-10 14:49:35 +01:00
cd pygomx-module
pip install -r requirements.txt
make install
2026-01-31 08:13:53 +01:00
2026-02-10 14:49:35 +01:00
(run 'make clean' to remove any generated)
2026-01-31 08:13:53 +01:00
2026-02-10 14:49:35 +01:00
cd ../smal
pip install [-e] .
2026-01-12 17:39:34 +01:00
2026-02-10 14:49:35 +01:00
usage:
2026-01-12 17:39:34 +01:00
2026-02-10 14:49:35 +01:00
cd into an empty dir (you might create one)
2026-01-12 17:39:34 +01:00
2026-02-10 14:49:35 +01:00
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
2026-01-12 17:39:34 +01:00
2026-02-10 14:49:35 +01:00
commands:
mxdiscover
mxwhoami
mxtoken
mxaccountinfo
mxclearaccount
mxserverinfo
demobot
2026-01-31 08:13:53 +01:00
2026-02-10 14:49:35 +01:00
matrix room:
#pygomx:matrix.org
https://matrix.to/#/#pygomx:matrix.org