README.md

   1 ## About
   2
   3 Cadbury is a friendly composable multi-purpose Matrix bot.
   4
   5 See `pyproject.toml` for the dependencies.
   6 Note that each dependency provides a separate dedicated bot role.
   7 Bots roles are composed with a couple lines of code in `app.py` before connecting to the Matrix server.
   8
   9 Although each bot role can run separately with separate credentials,
  10 the purpose of `Cadbury` is to compose several together under a single Matrix bot login.
  11
  12 ## Getting Started
  13
  14 Create a bot account on your Matrix server, and set the necessary environment variables: `MATRIX_SERVER`, `MATRIX_BOT`, `MATRIX_BOT_PWD`.
  15
  16 > Tip: Cadbury has no use for email. Your Matrix server may allow creating the bot account without an email account, using a `token` registration type.
  17
  18 Run the bot with `make serve`,
  19 or build a virtual environment and then run the bot with
  20
  21 Or run the following commands to create the virtual environment:
  22
  23         python -m venv .venv
  24         .venv/bin/pip install .
  25
  26 Then use the following command to launch the bot:
  27
  28         .venv/bin/python app.py
  29
  30 ## Remixing
  31
  32 When creating your own unique mix of bot roles, consider creating a public fork of
  33 this repository and modifying `app.py` and `pyproject.toml` as needed.
  34
  35 Note the AGPLv3 license, and please share your own modifications publicly, if you choose to use a modified version of this bot in a public setting.
  36
  37 ## About the Name
  38
  39 Named for Cadbury C. Cadbury, or Herbert Arthur Runcible Cadbury.
  40
  41     The Riches' butler who attends to the Rich estate. British born, Cadbury gives the image of propriety and service. When need demands however, he becomes a tough, man of action. Cadbury is also a master hypnotist, ventriloquist and wood-carver.
  42
  43