Bump version

[sid.git] / sid / feeds.py

diff --git a/sid/feeds.py b/sid/feeds.py
index 1b31b5cf1e9bd8212d2417aca872e390f6950cf4..3fe7ce9ecdd406dbe9d9ba43b977e01c5e6144ba 100644 (file)
--- a/sid/feeds.py
+++ b/sid/feeds.py
@@ -1,18 +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).
 
-# Copyright (C) 2011, 2014, 2020 kaliko <kaliko@azylum.org>
+Can easily be used for other feeds (rss, atom).
 
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, version 3 only.
+.. note::
+  Feeds plugin depends on external module: **feedparser**
 
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+>>> 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