sch/BukuBot
1
0
Fork 0
mirror of https://codeberg.org/sch/BukuBot synced 2024-12-22 09:55:24 +01:00
Code Issues 3 Projects Releases Packages Wiki Activity Actions
A bookmark bot powered by buku.
14 commits 1 branch 0 tags 420 KiB
Python 100%
Find a file
Schimon Jehudah, Adv. e27e87c43b Fix error upon an attempt to display information from an id which does not exist; Allow a deletion of multiple bookmarks.
2024-06-02 18:51:00 +03:00
bukubot Fix error upon an attempt to display information from an id which does not exist; Allow a deletion of multiple bookmarks. 2024-06-02 18:51:00 +03:00
LICENSE Add files license and pyproject. 2024-04-05 15:36:01 +00:00
pyproject.toml Refactor file structure. 2024-05-31 12:18:59 +03:00
README.md Add instructions to run the bot without prompts. 2024-05-31 13:59:50 +03:00

README.md

Bookmarks bot for XMPP

BukuBot

BukuBot is a bookmarks bot for the XMPP communication network.

BukuBot is a powered by buku and slixmpp.

XMPP

XMPP is the Extensible Messaging and Presence Protocol, a set of open technologies for instant messaging, presence, multi-party chat, voice and video calls, collaboration, lightweight middleware, content syndication, and generalized routing of XML data.

Visit XMPP for more information about the XMPP protocol and check the list of XMPP clients.

BukuBot is primarily designed for XMPP (aka Jabber), yet it is built to be extended to other protocols.

Features

  • Search - Filter and search bookmarks by keywords and tags.
  • Portable - Export and import bookmarks to buku database, HTML, Markdown, Orgfile, or XBEL.
  • Simultaneous - BukuBot is designed to handle multiple contacts, including groupchats, Simultaneously.
  • Visual interface - Interactive interface for XMPP using Ad-Hoc Commands,

Preview

BukuBot as appears with Cheogram.

Chat: Search Ad-Hoc: Commands Ad-Hoc: Browse Ad-Hoc: Add Ad-Hoc: Edit bookmark Ad-Hoc: Seach

Getting Started

Install

It is possible to install BukuBot using pip and pipx.

pip inside venv

$ python3 -m venv .venv
$ source .venv/bin/activate
$ pip install git+https://git.xmpp-it.net/sch/BukuBot

pipx

Install
$ pipx install git+https://git.xmpp-it.net/sch/BukuBot
Update
$ pipx uninstall bukubot
$ pipx install git+https://git.xmpp-it.net/sch/BukuBot

Start

Start by executing the command bukubot and enter Username and Password of an existing XMPP account.

$ bukubot

You can also start BukuBot as follows:

$ bukubot --jid ACCOUNT_JABBER_ID --password ACCOUNT_PASSWORD

It is advised to use a dedicated extra account for BukuBot.

Recommended Clients

BukuBot works with any XMPP chat client; if you want to make use of the visual interface which BukuBot has to offer (i.e. Ad-Hoc Commands), then you are advised to use Cheogram, Converse, Gajim, monocles chat, Movim, Poezio, Profanity, Psi or Psi+.

Support

Please join our support groupchat whether you want help, discuss new features or just greet us.

Authors

Schimon (Author).

License

MIT license.

Copyright

Schimon Zackary, 2024