a pretty basic websocket wrapper for reddit chatrooms
Project description
a fully functional (almost) bot library for reddit chatrooms!
no selenium no bullsh*t, just directly websocket
works either with reddit username & password or the api token (not a regular one you get from your registered app)
re-authentication prior to auto reconnect is only possible with PasswordAuth
Installation
pip install Reddit-ChatBot-Python
required:
python<=3.8.7
packages:
websocket_client
requests
numpy
wsaccel
wsaccel and numpy are for extra performance in websocket operations
Example
from Reddit_ChatBot_Python import ChatBot, RedditAuthentication
import random # for a basic dice rolling game
# create authentication with username and pass
reddit_authentication = RedditAuthentication.PasswordAuth(reddit_username="", reddit_password="", twofa="") # 2FA supported although not necessary obv..
# instantiate the chatbot
chatbot = ChatBot(print_chat=True, store_session=True, print_websocket_frames=False, # some parameters u might wanna know
authentication=reddit_authentication)
# you can add a rate limit like so:
chatbot.enable_rate_limiter(max_calls=23, # how many messages will be sent by the bot
period=1.5 # in what period (minutes)
)
# now you can add hooks which will be executed when a frame is received like so:
@chatbot.after_message_hook() # default frame_type is MESG
def dice_roller(resp): # resp is a SimpleNamespace that carries all the data of the received frame
messg_s = resp.message.split()
if messg_s[0] == "!roll" and len(messg_s) == 3: # if received message says !roll
limit_bottom = int(messg_s[1])
limit_top = int(messg_s[2])
rolled_number = random.randint(limit_bottom, limit_top)
response_text = f"@{resp.user.name} {rolled_number}. Better luck next time!"
# a basic roll game
# send typing indicator cuz why not? maybe they think you are a real person
chatbot.send_typing_indicator(resp.channel_url)
chatbot.send_message(response_text, resp.channel_url) # and send the message, always add resp.channel_url as the second argument
chatbot.send_snoomoji('partyparrot', resp.channel_url) # and send a snoomoji cuz why not??
return True # return true if you want to be done with checking the other hooks, otherwise return None or False
# keep in mind that first added hooks gets executed first
# now everytime someone says "!roll 1 100", the bot will roll a dice between 1 and 100 and send the result!
@chatbot.after_message_hook()
def keeper_of_decency(resp): # WE WILL KEEP THE DECENCY IN THE CHAT BOIS
if resp.message == "*some very bad slur word*":
chatbot.kick_user(channel_url=resp.channel_url, user_id=resp.user.guest_id, duration=600) # duration is in secs
chatbot.send_message(f'i banned {resp.user.name} for 10 mins', resp.channel_url)
return True
elif resp.message == "*another bad word*":
chatbot.delete_mesg(channel_url=resp.channel_url, msg_id=resp.msg_id)
chatbot.send_message(f"i deleted {resp.user.name}'s message", resp.channel_url)
return True
# or you can add a basic response hook directly like so:
chatbot.set_respond_hook(input_="Hi", response="Hello {nickname}! sup?", limited_to_users=None, lower_the_input=False,
exclude_itself=True, must_be_equal=True, limited_to_channels=["my cozy chat group"]) # you can limit by indicating chatroom's name
# you can add a welcome message for newly joined users:
chatbot.set_welcome_message("welcome to the my cozy chat group u/{nickname}!)", limited_to_channels=["my cozy chat group"])
# and a farewell message too:
chatbot.set_farewell_message("Too bad u/{nickname} left us :()", limited_to_channels=["my cozy chat group"])
# there is also another hook type for invitation frames
@chatbot.on_invitation_hook
def on_invit(resp):
if resp.channel_type == "group":
invit_type = "group chat"
elif resp.channel_type == "direct":
invit_type = "DM"
else:
invit_type = None
print(f"got invited to {invit_type} by {resp.data.inviter.nickname}")
chatbot.accept_chat_invite(resp.channel_url)
chatbot.send_message("Hello! I accepted your invite", resp.channel_url)
# and finally, run forever...
chatbot.run_4ever(auto_reconnect=True) # set auto_reconnect so as to re-connect in case remote server shuts down the connection after some period of time
Instance of a MESG Frame (regular chat message)
{
"msg_id": *msg id int*,
"is_op_msg": false,
"is_guest_msg": true,
"message": "*msg*",
"silent": false,
"ts": 1611782454265,
"channel_url": "sendbird_group_channel_000000000_0000000000000000000000000000000000000000",
"is_removed": false,
"sts": 1611782454265,
"user": {
"is_blocked_by_me": false,
"require_auth_for_profile_image": false,
"name": "*user nickname*",
"is_bot": false,
"image": "",
"is_active": true,
"guest_id": "*thing id*",
"friend_discovery_key": null,
"role": "",
"friend_name": null,
"id": *user id int*,
},
}
You can access stuff from resp like this:
message = resp.message
nickname = resp.user.name
Instance of a Invitation Frame (frame type SYEV)
{
"unread_cnt": {
"all": 1,
"ts": 1614006345986
},
"is_super": false,
"data": {
"inviter": {
"nickname": "*inviter nickname*",
"metadata": {
},
"require_auth_for_profile_image": false,
"profile_url": "",
"user_id": "*user id str t2_ included*"
},
"invited_at": 1614006345956,
"invitees": [
{
"nickname": "*bot's nickname*",
"metadata": {
},
"require_auth_for_profile_image": false,
"profile_url": "",
"user_id": "*user id str t2_ included*"
}
]
},
"ts": 1614006345978,
"is_access_code_required": false,
"cat": 10020,
"channel_type": "*can either be 'group' for group chat or 'direct' for DM*",
"channel_id": *channel_id str*,
"sts": 1614006345978,
"channel_url": "sendbird_group_channel_000000000_0000000000000000000000000000000000000000"
}
You can access stuff from Invitation resp like this:
message = resp.data.inviter.nickname
direct_or_group = resp.channel_type
Showcase of some other fun stuff you can do with this..
Save chatroom messages to a text file (or even in an sql database or some other sht)
messages_f_handle = open('reddit-chat-msgs.txt', 'w')
@chatbot.after_message_hook(frame_type='MESG')
def save_chat_messages_into_a_txt_file(resp):
chatroom_name_id_pairs = chatbot.get_chatroom_name_id_pairs()
message = resp.message
nickname = resp.user.name
chatroom_name = chatroom_name_id_pairs.get(resp.channel_url)
formatted_msg = f"{nickname} said {message} in {chatroom_name}"
messages_f_handle.write(formatted_msg)
messages_f_handle.flush()
Catch deleted messages
@chatbot.after_message_hook(frame_type='DELM')
def catch_deleted_messages(resp):
catched_deleted_message_id = resp.msg_id
Catch who invited who
@chatbot.after_message_hook(frame_type='SYEV')
def catch_invitees_and_inviters(resp):
try:
inviter = resp.data.inviter.nickname
invitees = [invitee.nickname for invitee in resp.data.invitees]
except AttributeError:
return
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for Reddit_ChatBot_Python-1.2.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b5521da17c87a58fe42494b2c8df3dcc7b521f4f99cf64a75d95f27ff6a36e7c |
|
MD5 | 8352a10956b9d3210b3a4882ff51714d |
|
BLAKE2b-256 | 15fd9492a51d2603672d674ab2079e97b1c685efc7531f66696dae7452f9fff9 |
Hashes for Reddit_ChatBot_Python-1.2.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 29cbdfaed08f05cd3774935a52d5111bb1b28addb3b186f62bc345d1924af193 |
|
MD5 | d8f19422d81f4b8c4db93b87b9386408 |
|
BLAKE2b-256 | 9a7e3318deb0ea03d3bdef3a8bfa84a92f6e300d0d147c7f5ad08165df0becea |