README.md

   1 ## About
   2
   3 A matrix bot that tracks visions and goals.
   4
   5 Add the bot to your Matrix room, and start telling it your goals. Then add tasks, and organize your goals by vision.
   6
   7 Works well with, and is included in [Cadbury, the many purpose Matrix bot](https://codeberg.org/EdTheDev/matrix-cadbury).
   8
   9 ## Usage
  10
  11 Configure the necessary environment variables, and run with `make serve`.
  12
  13 Invite the bot to a Matrix channel, and it will accept automatically, if it can.
  14
  15 Use `!goal help`, to get started.
  16
  17 > Tip: Additional setup is required to add a Matrix bot to an encrypted channel.
  18
  19 ```
  20     Prefix: !goal
  21
  22     Synax:
  23         !goal COMMAND ARGS
  24
  25     Commands:
  26       help - show this help
  27       add - add a goal
  28       add-task ID - add a task under the goal specified by ID
  29       add-vision - add a new vision (collection of goals)
  30       close-goal ID - mark goal done by ID
  31       close-vision ID - mark vision as complete by ID
  32       done ID - mark task done by ID
  33       list - list incomplete goals
  34       ... etc ...
  35 ```
  36
  37 This bot can also be invoked from the commande line with `invoke`.
  38
  39     ```sh
  40     git clone https://codeberg.org/EdTheDev/matrix-goal-bot.git
  41     cd matrix-goal-bot
  42     make .venv
  43     source .venv/bin/activate
  44     invoke --list
  45     ```
  46
  47 ## TODO List
  48
  49 - [x] fix error wrapper in chores and goals must print rather than return (38)
  50 - [x] update goal bot to allow closing multiple tasks in one command (51)
  51 - [x] add command to list goals with no vision (53)
  52 - [x] update __str for a goal to display [DONE - YYYY.MM] if completed (54)
  53 - [ ] update goal bot to be able to run multiple databases under different prefixes so that !someday could be a separate database file (55)
  54 - [ ] assuming 55 above, update Cadbuary to include a separate `!someday` command as an example
  55 - [ ] update goal bot to prefer last mentioned goal when adding tasks (see shop bot source code) (36)
  56
  57 ## Support
  58
  59 As of the last update to this README, the expected End-of-Life date of this product is October 2028.
  60
  61 End-of-Life was decided upon based on these dependencies:
  62
  63     - Python 3.12 (October 2028)