thecoffemaker/Slixfeed
1
0
Fork 0
forked from sch/Slixfeed
Code Pull requests Activity
Syndication bot for XMPP which is powered by feedparser and slixmpp.
373 commits 1 branch 0 tags 2.7 MiB
Python 100%
Find a file
Schimon Jehudah, Adv. 09bd838ad2 Add a selection mechanism to manage whitelist and blacklist.
2024-11-15 13:34:26 +02:00
slixfeed Add a selection mechanism to manage whitelist and blacklist. 2024-11-15 13:34:26 +02:00
LICENSE Add LICENSE 2023-11-29 15:25:23 +00:00
MANIFEST.in Add MANIFEST.in 2024-01-28 13:10:48 +00:00
pyproject.toml Python : Add support for newer OMEMO (Thank you. Syndance); 2024-09-12 15:20:14 +03:00
README.md Python : Set OMEMO as an optional dependency; 2024-09-11 09:48:27 +03:00
THANKS.md Fix configuration and allow commenting unused keys 2024-01-24 19:41:40 +00:00

README.md

Work in Progress

This bot is still a work in progress. Albeit this bot works well in most cases, it is not yet ready for production. We are working to make this bot better.

Syndication bot for XMPP

Slixfeed

Slixfeed is a news aggregator bot for the XMPP communication network which aims to be easy to use and fully-featured. It provides a convenient access to Blog and News sites.

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.

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

Features

  • Ease - Slixfeed automatically scans (i.e. crawls) for syndication feeds of given URL.
  • Encryption - Messages are encrypted with the OMEMO standard.
  • Export - Download articles as ePUB, HTML, Markdown and PDF.
  • Filtering - Filter news items using lists of allow and deny.
  • Multimedia - Display audios pictures and videos inline.
  • Privacy - Redirect to alternative back-ends, such as Invidious, Librarian, Nitter, for increased privacy, productivity and security.
  • Portable - Export and import feeds with a standard OPML file.
  • Simultaneous - Slixfeed is designed to handle multiple contacts, including groupchats, Simultaneously.
  • Visual interface - Interactive interface for XMPP using Ad-Hoc Commands,

Preview

monocles chat

Chat: Add URL Ad-Hoc: Commands

Cheogram

Ad-Hoc: Add URL Ad-Hoc: Settings

Getting Started

Install

It is possible to install Slixfeed using pip and pipx.

pip inside venv

$ python3 -m venv .venv
$ source .venv/bin/activate
Install
$ pip install git+https://git.xmpp-it.net/sch/Slixfeed
Install (OMEMO)
$ pip install git+https://git.xmpp-it.net/sch/Slixfeed[omemo]

pipx

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

Start

$ slixfeed

Usage

  • Add the bot to contact list and follow it instructions.
  • Send command help or commands for a list of commands.

Recommended Clients

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

Support

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

Authors

  • Schimon (Author).
  • Laura (Co-Author, Instructor and Mentor).

Contributors

  • Mr. Stephen Paul Weber from Sopranica who has provided code for Data Forms to be used as visual interface for Ad-Hoc Commands, and who has taught me about Data Forms.

Thanks

Acknowledgment

Special thank you to Mrs. Lapina who instructed me during months to complete this, in addition to significant code fixes.

Laura, I thank you greatly for your encouragement, time and help. This software would not have existed without you.

May this software be a life changing factor to people the world over.

License

MIT license.

Copyright

  • Schimon Zackary 2022 - 2024
  • Laura Lapina 2022 - 2023

Similar Projects

Please visit our friends who offer different approach to convey syndication feeds to XMPP.

  • AtomToPubsub Syndication feeds as XMPP Pubsub Nodes.

  • err-rssreader A port of old Brutal's RSS Reader for Errbot.

  • feed-to-muc An XMPP bot which posts to a MUC (groupchat) if there is an update in newsfeeds.

  • Jabber RSS Transport Syndication feeds as contacts.

  • JabRSS by Christof A simple syndication headline notification service for Jabber/XMPP.

  • JabRSS by Jens W. Wulf Never miss a headline again! JabRSS is a simple syndication headline notification service for Jabber.

  • Morbot Morbo is a simple Slixmpp bot that will take new articles from listed syndication feeds and send them to assigned XMPP MUCs (groupchats).

  • XMPP Bot An XMPP bot for making the link between XMPP conversations and webhooks.