spla/xmppbot.py
1
0
Fork 0
Codi Incidències Sol·licituds Pull repo.project Llançaments Paquets Wiki Activitat Actions
Bot to manage a xmpp ejabberd local node from a Mastodon server, by posting keywords to it.
10 commits 1 branch 0 tags 64 KiB
Python 100%
Anar al arxiu
spla da93574d73 Changed some vars visibility and Fix #3
2022-08-21 10:52:08 +02:00
app/locales Added 'ca' and 'en' locale strings 2022-08-18 10:24:30 +02:00
ejabberdapi.py Changed some vars visibility and Fix #3 2022-08-21 10:52:08 +02:00
LICENSE Firs release (WIP) 2022-08-18 10:03:27 +02:00
mastodonbot.py Fixed not saving locale config 2022-08-18 13:13:23 +02:00
README.md Updated 2022-08-18 10:28:20 +02:00
requirements.txt Added requerimentx.txt and the listen bot, xmpp.py 2022-08-18 13:16:56 +02:00
xmpp.py Changed some vars visibility and Fix #3 2022-08-21 10:52:08 +02:00

README.md

xmpp bot for Mastodon

Bot to manage a xmpp ejabberd node from a Mastodon server, by posting keywords to it.

The bot only listen keywords from your Mastodon server local users. They can register themselves to your ejabberd xmpp server, unregister, check your xmpp node stats and more!.
The keywords that they can issue against the bot are the following:

@your_bot register
@your_bot unregister
@your_bot stats
@your_bot status
@your_bot sessions

The bot will process any of the above keywords thanks to the wrapper for ejabberd API (ejabberdapi.py, coded by me (WIP)) and the excellent wrapper for Mastodon API coded by halcy.

The first time you run python xmpp.py, it will ask you for the needed parameters like:

  • api_base_url: http://127.0.0.1:5280 (ejabberd server's API listen port)
  • local_vhost: your local ejabberd vhost
  • admin_account: the ejabberd admin account, in exemple admin@ejabberd.server
  • admin_pass: ejabberd admin account password
  • Mastodon hostname: in ex. your.mastodon.server.host
  • bot's replies language (ca or en)

Requirements

  • Mastodon server bot account
  • xmpp Ejabberd local node with admin privileges

Before running python xmpp.py:

  1. git clone https://git.mastodont.cat/spla/xmppbot.py target_dir.
  2. cd target_dir
  3. create the Python Virtual Environment with python3.x -m venv .
  4. activate it with source bin/activate
  5. run pip install -r requirements.txt to install required libraries.
  6. set up your contrab to run python xmpp.py every minute.

Enjoy!