X-Git-Url: http://git.kaliko.me/?p=sid.git;a=blobdiff_plain;f=sid%2Ffeeds.py;fp=sid%2Ffeeds.py;h=3fe7ce9ecdd406dbe9d9ba43b977e01c5e6144ba;hp=466aaece82ee6f0554bd81fb3883b946f1796fd2;hb=b32d7a8cb7b1bd5cd16e461d14ed94891b93014f;hpb=1aea0b1d518984cc82c616c584a4fa7d20b81ec5

diff --git a/sid/feeds.py b/sid/feeds.py
index 466aaec..3fe7ce9 100644
--- 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