Metadata-Version: 2.1
Name: feedsbot
Version: 0.2.0
Summary: Subscribe to RSS/Atom feeds in Delta Chat
Author-email: adbenitez <adb@merlinux.eu>
Keywords: deltachat,bot,feeds,rss,atom
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: deltabot-cli <4.0,>=3.2.3
Requires-Dist: SQLAlchemy <3.0,>=2.0.25
Requires-Dist: feedparser <7.0,>=6.0.11
Requires-Dist: requests <3.0,>=2.28.1
Requires-Dist: beautifulsoup4 <5.0,>=4.11.1
Requires-Dist: html5lib >=1.1
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: pylint ; extra == 'dev'
Requires-Dist: pylama ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: types-requests ; extra == 'dev'

# Feeds

[![Latest Release](https://img.shields.io/pypi/v/feedsbot.svg)](https://pypi.org/project/feedsbot)
[![CI](https://github.com/deltachat-bot/feedsbot/actions/workflows/python-ci.yml/badge.svg)](https://github.com/deltachat-bot/feedsbot/actions/workflows/python-ci.yml)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

Delta Chat bot that allows to subscribe to RSS/Atom feeds.

## Install

```sh
pip install feedsbot
```

Configure the bot:

```sh
feedsbot init bot@example.com PASSWORD
```

Start the bot:

```sh
feedsbot serve
```

Run `feedsbot --help` to see all available options.

## User Guide

To subscribe an existing group to some feed:

1. Add the bot to the group.
2. Send `/sub https://delta.chat/feed.xml` (replace the URL with the desired feed)

To subscribe to a feed and let the bot create a dedicated group for you with the feed image as group avatar, etc., just send the command `/sub https://delta.chat/feed.xml` (replacing the URL for the desired feed) to the bot in private/direct (1:1) chat.

To unsubscribe the group from all feeds, just remove the bot from the group, or to unsubscribe from a particular feed (replace feed URL as appropriate):

`/unsub https://delta.chat/feed.xml`

To see all feeds a group is subscribed to, just send `/list` inside the desired group.
