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 either with reddit username & password or the api token (not a regular one you get from your registered app), so you wont have to expose your pass
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
# create authentication with username and pass
reddit_authentication = RedditAuthentication.PasswordAuth(reddit_username="", reddit_password="")
# or you can directly authenticate with the self-obtained api token
reddit_authentication = RedditAuthentication.TokenAuth(token="")
# either of them is OK
# instantiate the chatbot
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, print_websocket_frames=False, # 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
# Dont forget to perform this check if you are just gonna do stuff with regular chat messages
# You can further investigate other types by setting print_websocket_frames to True and do some fun stuff
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_bottom), int(limit_top))
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 my cozy chat group", limited_to_users=None, lower_the_input=False,
exclude_itself=True, must_be_equal=True, limited_to_channels=["my cozy chat group"])
# you can add a welcome message for newly joined users too:
websock.set_welcome_message("welcome to the my cozy chat group u/{nickname}!", limited_to_channels=["my cozy chat group"]) # 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.6.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 50a4d92de45da1c37700466741306b3f029169b2579ccee8edc01560c25147fb |
|
MD5 | 6d63a399791fd151425513c171e6b98b |
|
BLAKE2b-256 | 893da20191d0033dc7094c933d05bdf31e9c9696f046c53c3fab76e0f8851ad6 |
Close
Hashes for Reddit_ChatBot_Python-1.1.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2643b7915070db1cc4cca1b16cf4777d741887b2c45fc4fbf44f513d6484ce81 |
|
MD5 | c04f24646c3018c15191a6bebd335c01 |
|
BLAKE2b-256 | 4982bf18b0916040752b605d0d8194dd688239f0b602ab1544eed095ad7136d7 |