Giter Club home page Giter Club logo

drbot's Introduction

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

drbot's People

Contributors

ewpratten avatar retnikt avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

Forkers

retnikt

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.