Git Product home page Git Product logo

lxmf-bot's Introduction

LXMFBot

Python class to easily develop a simple Telethon style chatbot for the LXMF protocol.

screenshot

Installation

$ pip install -r requirements.txt

Usage

  • Instantiate the class with a name for the bot as parameter.
    • Two additional options the class takes as parameters are announce to define the announce interval in seconds (defaults to 360) and an announce_immediately boolean to define whether the bot should announce itself immediately after instantiation or not (defaults to False)
  • Use the received decorator to define functions for parsing received messages
  • Use the <instance>.send(recipient_hash, message) or msg.reply(message) methods to send messages
  • Launch the bot using the run method

Message Object

Functions decorated by received have access to a msg parameter that has the following content:

  • msg.sender : the sender hash address
  • msg.content: the received message as utf-8 string
  • msg.reply : function that takes a string parameter and sends it as reply to the sender
  • msg.lxmf : the complete LXMessage object for more complex parsing

Example

Example of a bot that echos a message back to the sender:

from lxmfbot import LXMFBot

bot = LXMFBot("NodeBot")

@bot.received
def echo_msg(msg):
    msg.reply(msg.content)

bot.run()

Identity & Announce Files

The bots' identity and announce file location

OS Path
Linux: ~/.local/share/LXMFBot/<botname>
MacOS: ~/Library/Application Support/LXMFBot/<botname>
Windows: C:\Users\<username>\AppData\Local\LXMFBot\<botname>

lxmf-bot's People

Contributors

randogoth avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  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.