Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

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

This version

1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for drbot, version 1.0
Filename, size File type Python version Upload date Hashes
Filename, size drbot-1.0.tar.gz (3.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page