A Python3 library for easily building devRant bots
Project description
drbot
A Python3 library for easily building devRant bots
Using
To make a bot, all you need to do is extend the BotBuilder
class and define an onNotif()
method
from drbot.botbuilder import BotBuilder, NotifType
# Testing setup
class MyBot(BotBuilder):
onNotif(self, type, content):
# Handle notifs here
pass
# Create a bot
my_bot = MyBot("username", "password")
# Set how long the bot should wait between notif queries (in seconds)
interval = 10
# Start the bot
my_bot.start(interval)
That's it!
Using the API
Every BotBuilder
class has a built in API wrapper. This can be accessed through self.api
, and contains the following methods:
getUserInfo(username: str) -> dict
getUsername(user_id: int) -> str
postRant(body: str, tags: str) -> None
postComment(rant_id: int, content: str) -> None
getComment(comment_id: int) -> dict
The BotBuilder
automatically handles login, sessions, notif management, and some data parsing. If you are looking to override these, you may be interested in the following API methods:
login(username: str, password: str) -> None
hasAuthExpired() -> bool
getNotifs() -> list
clearNotifs() -> None
getUserId(username: str) -> int
Installing
This library is avalible on PYPI.
With python3.7
and python3-pip
installed, run:
pip3 install drbot
to install drbot
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
File details
Details for the file drbot-1.0.tar.gz
.
File metadata
- Download URL: drbot-1.0.tar.gz
- Upload date:
- Size: 3.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 922da96406d94fcedd55d93c7478a0b5d7f50289b78b46ce6e9592206f49d830 |
|
MD5 | 00e98f33fb666b218c49776d5f338727 |
|
BLAKE2b-256 | e2b1fe16c34980a833ae8aadda7e1472778d7e74c14b6516a440421015d7cdae |