annikacodes / expecto-botronum Goto Github PK

Things that need to happen:

• modular design
• classes
• User/auth tracking
• overall structure
• make a giant overview doc

See v3.md for details.

• importable way to save variables under names
• importable way to load variable from names they're saved under in data.json

This code is very long and difficult to read - a refactor would be good.

See v3.md for details.
Most of this can probably be ported from v2, although that code is a bit hacky zzz.

• main superhero API
• ~superhero in PMs (depends #13)

Depends on #4 and #5 (and #13 for PM html usage).

Could be a neat little feature extension, and potentially take over some of the functionality of the personal bot I run.

See this PS! code for how to use /cmd.

Currently, there are many false "error" messages caused by git pull sending stderr data on success, and iirc the bot also repeats messages.

See v3.md for details.

• Way to add/remove text snippets from data.json and display a random one in chat (2a9a5eb)
• Differentiate between commands for facts and topic while utilizing the same functions. (ffa1cc7)
• Upload to Pastebin using an API key from config (87c1eb5)

Depends on #4 and #5.

This would allow us to test modules that are reliant on data.json.

See v3.md for details.

Shouldn't be too complex, just a matter of watching for messages of type 'join' from particular users and saving/loading joinphrases to data.json.

Depends on #4 and #5.

Refactor .format() and string concatenation to f-strings, since we now have f-string support (Python 3.6!) on the bot host.

See v3.md for details.
I'm not going to add any checkboxes because this module is quite simple.
Depends on #4.

• tests for core,py
  • Message
  • Room
  • User
  • Connection
• tests for chatlog.py
• Module tests
  • tests for superhero.py
  • tests for games.py
  • tests for conversation.py
  • tests for base.py
  • tests for joinphrase.py
  • tests for admin.py

Now that we have the ps-client Python package, we can simplify this repo to avoid code duplication.

• a Connection.userlist attribute mapping Users to lists of roomids that's modified upon receiving a Message of type join or leave. (f8324cc)
• a Connection.getUser(id) attribute that can fetch a User object from the room's userlist (f8324cc)
• ways to prevent duplicating User objects - a check under Connection.userlist for other rooms the user is in, perhaps? (f8324cc)
• /userlist on joining a room + handler (e331f2e)

See v3.md for more info.

• Connection class (a58c901)
• Message class (b0b736f)
• Room class (3ba2080)
• User class (d5cac12)
• loading configuration from config.json (c45a028)
• example/skeleton for Module class (not technically in core.py but necessary for it to function) (a093d04)

For a challenge, add logging (#12) or joinphrase stuff (#8).

Add command(s) to utilize the Superhero API to get info on superheroes and provide it in chat in ways that are beneficial to M&M.

i.e. there are 2 different Atlases with IDs 48 and 49 respectively. The bot currently can only see Atlas with ID 49.

Something like this.

While v3.md and Python's docstrings are good programmer-facing documentation, there should be some kind of documentation of commands for PS! users, and perhaps more documentation of config.json options too, since that doesn't have docstrings.

In src/lib.rs.

See v3.md for details.

• Minigame score tracking (doesn't need to be persistent over reboots, imo). (52ed782)
• Reversio (a1c072f)
• Tournaments (79963cb)
• UNO (f5cea86)

Depends on #4 and potentially #5.

if two things use data.get() and then later data.set() there is no lock and data could be overwritten. this is bad. i am very hot and tired but future annika please deal with this

Probably an issue with the API but could be in Expecto's parsing code.
EDIT: it was in the parsing code.