Marvin is a simple bot designed to send messages to a Matrix room on a given schedule to inquire about the availability of members for different days of the week.
Marvin uses the following environment variables to function correctly:
MATRIX_HOMESERVER
: The URL of your Matrix homeserver (e.g.,https://matrix.org
)MATRIX_ACCESSTOKEN
: Your Matrix access tokenMATRIX_ROOMID
: The ID of the Matrix room where messages will be sentMATRIX_MESSAGE
: The message content to be sent
-
Clone the repository or download the script.
-
Install the required Python libraries:
rye sync
-
Set up the required environment variables. You can create a
.env
file in the same directory by copying theenv.example
as the script for convenience:export MATRIX_HOMESERVER="https://matrix.org" export MATRIX_ACCESSTOKEN="YOUR_ACCESS_TOKEN" export MATRIX_ROOMID="!yourRoomID:matrix.org" export MATRIX_MESSAGE="Which day do you want to play?"
To run the bot, execute the rye run marvin
command.
This script uses github workflows to run every sunday.
This project is licensed under the MIT License. See the LICENSE file for details.