a pretty basic websocket wrapper for reddit chatrooms
Project description
REDDIT IS KILLING COMMUNITY CHATS FEATURE. I WILL SEE WHAT CAN BE DONE FOR GROUP CHATS
Reddit ChatRoom
a pretty basic websocket wrapper for reddit chatrooms
no selenium no bullsh*t, just directly websocket
works with the api token (not a regular one you get from your registered app), so you wont have to expose your pass
there is a script to dump sendbird access scoped token available here
Installation
pip install Reddit-ChatBot-Python
required packages:
websocket_client>=0.57.0
requests>=2.24.0
Usage
from Reddit_ChatBot_Python.ChatBot import ChatBot, RedditAuthentication
reddit_authentication = RedditAuthentication.PasswordAuth(reddit_username="", reddit_password="") # create authentication with username and pass
reddit_authentication = RedditAuthentication.TokenAuth(token="") # or you can directly authenticate with the self-obtained api token
# either of them is OK
# instantiate a chatbot and pass in the sub_channels if you want
chatbot = ChatBot(global_blacklist_words={'a', 'b'}, # you can define words that shouldnt be sent (this migth be handy for slurs)
global_blacklist_users={'a', 'b'}, # hooks never get executed for users in this list
print_chat=True, store_session=True, dont_answer_blocked=True, # some parameters u might wanna know
authentication=reddit_authentication)
# grab the websocket
websock = chatbot.WebSocketClient
# you can add a rate limit like so:
websock.RateLimiter.is_enabled = True
websock.RateLimiter.max_calls = 23 # how many messages will be sent by the bot
websock.RateLimiter.period = 1.5 # in what period(in minutes)
# now you can add hooks to the websock object in order for them to be executed when a message is received like so:
# create a function and hook
@websock.after_message_hook
def roll(resp): # resp is a namedtuple that carries all the data of the received frame
if resp.type_f == "MESG": # MESG is the type of the ordinary chat messages. you can see others here: https://github.com/scrubjay55/Reddit_ChatBot_Python/blob/master/Utils/FrameModel/FrameModel.py
# Dont forget to perform this check if you are just gonna do stuff with regular chat messages
messg_s = resp.message.split()
if messg_s[0] == "!roll" and len(messg_s) == 3: # if received message says !roll
limit_bottom = messg_s[1]
limit_top = messg_s[2]
rolled_number = random.randint(int(limit_f), int(limit_u))
response_text = f"@{resp.user.name} {rolled_number}. Better luck next time!"
# a basic roll game
websock.send_message(response_text, resp.channel_url) # and send the message, always add resp.channel_url as the second argument
websock.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
# keep in mind that first added hooks gets executed first
# now everytime someone says "!roll 1 100", the bot will roll and send the result!
# or you can add a basic response hook directly like so:
websock.set_respond_hook(input_="Hi", response="Hello {nickname}! enjoy your time in r/askreddit chatroom", limited_to_users=None, lower_the_input=False,
exclude_itself=True, must_be_equal=True, limited_to_channels=["AskReddit"])
# you can add a welcome message for newly joined users too:
websock.set_welcome_message("welcome to the r/askreddit chatroom u/{nickname}!", limited_to_channels=["AskReddit"]) # you can limit by indicating chatroom's name
# and finally, run forever...
websock.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
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
Close
Hashes for Reddit_ChatBot_Python-1.1.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f0053b788c98a596ca8e3d7b0a3650d604c0ec6695667fc98d7dcee3b04811f |
|
MD5 | e5a73ba25f2431c29013fdf1385b8966 |
|
BLAKE2b-256 | c88cc58316257e64daf029e4832be860791668a4dae250ba4886b837370b6983 |
Close
Hashes for Reddit_ChatBot_Python-1.1.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | aaa44bfdbf8d2e36a23eb5dc9ad2b231cd83959d13fb3118876c7718c4d33139 |
|
MD5 | 2b9d2c50dccc2d6e620984f4135180f4 |
|
BLAKE2b-256 | 3dd3711003be21413b8ada0114b91e599d62c323f33108817148903f3ff5f65d |