Giter Club home page Giter Club logo

fbchatbot's Introduction

fbchatbot - A framework for writing FB Messenger bots

fbchat does all the heavy lifting. Thanks fbchat!

Very much still in progress! ๐Ÿ‘ท

Very much subject to breaking change! :trollface:

Example:

import config
from fbchatbot import *
from fbchatbot.core_events import CommandEvent, TextMessageEvent


use_config(config)
bot = add_bot("bot1").claim_threads(config.THREADS["my_thread"])

@bot.listener
def my_echo(e: TextMessageEvent):
    print(e.text)

@bot.command("hi")
def say_hi(e: CommandEvent):
    """Say hi back"""
    e.thread.send_text("Hello")

bot.listen()

Features

Built-in events

Comes with new events, normalizing the ones fbchat provides to make some tasks easier

Type-directed event listeners

Use type hints to specify what events to listen for:

@bot.listener
def my_echo(e: MessageEvent):
    print("bot: " + e.message.text)

Or don't...

@bot.listener(MessageEvent)
def my_echo(e):
    print("bot: " + e.message.text)

Plugin system

Break functionality into plugins! Distribute them, maybe one day.

On the roadmap

  • Logging plugin!
  • Optional message queue!
  • Configure behavior at the user/group thread level

Examples

Plugin example (out of date)

my_plugin.py

from fbchatbot import Plugin


my_plugin = Plugin("MyPlugin")

@my_plugin.listener
def my_echo(e: MessageEvent):
    print("bot: " + e.message.text)

main.py

import config
from .my_plugin import my_plugin
from fbchatbot import Chatbot


bot = Chatbot(config=config)
bot.load_plugin(my_plugin)
bot.listen()

fbchatbot's People

Contributors

wetmore avatar

Watchers

 avatar James Cloos avatar

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.