doc: Improve and update

[sid.git] / sid / feeds.py

diff --git a/sid/feeds.py b/sid/feeds.py
index 466aaece82ee6f0554bd81fb3883b946f1796fd2..3fe7ce9ecdd406dbe9d9ba43b977e01c5e6144ba 100644 (file)
--- a/sid/feeds.py
+++ b/sid/feeds.py
@@ -1,6 +1,21 @@
 # -*- coding: utf-8 -*-
 # SPDX-FileCopyrightText: 2011, 2014, 2020 kaliko <kaliko@azylum.org>
 # SPDX-License-Identifier: GPL-3.0-or-later
+"""Publish news from various Debian feeds (security, planet, package tracker, see :py:obj:`sid.feeds.Feeds.FEEDS` for defaults).
+
+Can easily be used for other feeds (rss, atom).
+
+.. note::
+  Feeds plugin depends on external module: **feedparser**
+
+>>> from sid.feeds import Feeds
+>>> # Time between check in seconds
+>>> Feeds.TEMPO = 60
+>>> # Fedds to monitor, cf. sid.feeds.Feeds.FEEDS for defaults
+>>> Feeds.FEEDS = [
+        'https://example.org/feeds/atom/news.atom.xml'
+        ]
+"""
 
 import datetime
 import threading