Slixfeed/README.md

76 lines
2.5 KiB
Markdown
Raw Normal View History

2022-06-21 15:39:08 +02:00
# Slixfeed
2022-06-21 16:19:01 +02:00
Syndication bot for the XMPP communication network.
2022-06-21 15:39:08 +02:00
2023-11-28 17:13:57 +01:00
Slixfeed aims to be an easy to use and fully-featured news aggregator bot for XMPP. It provides a convenient access to Blogs, Fediverse and News websites along with filtering functionality.
Slixfeed is primarily designed for XMPP (aka Jabber).
Visit https://xmpp.org/software/ for more information.
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 https://xmpp.org/about/ for more information on the XMPP protocol.
## Getting Started
2022-06-21 15:39:08 +02:00
```
2022-06-21 19:12:31 +02:00
$ python slixfeed.py
2022-06-21 16:19:01 +02:00
Username:
Password:
2022-06-21 15:39:08 +02:00
```
## Usage
2022-06-30 18:02:00 +02:00
- Start bot;
- Add contact JID of Slixfeed to your roster;
- Open chat with Slixfeed;
2023-11-28 17:13:57 +01:00
- Add news source by sending a `<url>` (in groupchat, use `!<url>`).
2022-06-21 15:39:08 +02:00
2023-11-28 17:13:57 +01:00
### Feeds
Example feeds you can subscribe to.
2022-06-21 16:19:01 +02:00
```
2023-11-28 17:13:57 +01:00
https://xmpp.org/feeds/all.atom.xml
https://takebackourtech.org/rss/
https://redecentralize.org/podcast/feed.rss
http://hackerpublicradio.org/hpr_ogg_rss.php
https://www.blacklistednews.com/rss.php
https://theconsciousresistance.com/feed/
2022-06-21 16:19:01 +02:00
```
2022-06-21 15:39:08 +02:00
## Roadmap
2022-06-21 16:19:01 +02:00
- Improve asynchronism hadling;
2023-11-28 17:13:57 +01:00
- Improve logging and error handling;
2022-06-21 16:20:24 +02:00
- Add daemon interface;
2023-11-28 17:13:57 +01:00
- Add HTML support (XHTML-IM);
2022-06-21 16:26:08 +02:00
- Add feed history tables of last week and last month.
2022-06-21 15:39:08 +02:00
2023-11-28 17:13:57 +01:00
## Authors
2022-06-21 16:19:01 +02:00
- Schimon Jehudah, Attorney at Law.
2023-11-28 17:13:57 +01:00
- [Laura](xmpp:lauranna@404.city) (Instructor, mentor and co-author).
## Acknowledgment
2022-06-30 18:02:00 +02:00
- [Alixander Court](https://alixandercourt.com/)
2022-06-21 19:12:31 +02:00
- [edhelas](https://github.com/edhelas/atomtopubsub)
2022-12-11 14:49:48 +01:00
- habnabit_ from #python on irc.libera.chat (SQL security)
2022-06-26 19:32:11 +02:00
- [imattau](https://github.com/imattau/atomtopubsub) (Some code, mostly URL handling, was taken from imattau)
2022-06-21 16:19:01 +02:00
- [Link Mauve](https://linkmauve.fr/contact.xhtml)
2022-06-26 19:32:11 +02:00
- magicfelix (async)
2022-06-21 16:19:01 +02:00
- Slixmpp participants who chose to remain anonymous or not to appear in this list.
2022-06-21 15:39:08 +02:00
## License
2023-11-28 17:13:57 +01:00
GPL-3.0 license
2022-06-21 16:26:08 +02:00
## Copyright
2023-11-28 17:13:57 +01:00
- Schimon Jehudah 2022 - 2023
- Laura 2022 - 2023
## Similar Projects
Please visit our friends who offer different approach to convey RSS to XMPP.
* [AtomToPubsub](https://github.com/imattau/atomtopubsub)
RSS feeds as XMPP Pubsub Nodes.
* [feed-to-muc](https://salsa.debian.org/mdosch/feed-to-muc)
An XMPP bot which posts to a MUC (groupchat) if there is an update in newsfeeds.
* [Morbot](https://codeberg.org/TheCoffeMaker/Morbot)
Morbo is a simple Slixmpp bot that will take new articles from listed RSS feeds and send them to assigned XMPP MUCs (groupchats).