feedstail 0.5.1

许可证

Feedstail 在GNU通用公共许可证 v3 或更高版本下发布。

入门

使用pip轻松安装feedstail

$ pip install feedstail

或者使用git检索项目并安装

$ git clone https://github.com/Psycojoker/feedstail.git
$ cd feedstail
$ python setup.py install

然后，使用随机订阅测试feedstail

$ feedstail -u http://hackeragenda.be/events/events.rss

示例

默认情况下，feedstail 将每15分钟检查一次订阅。如果您想自定义此间隔，可以使用 i 选项。以下示例将每5秒检索一次订阅

$ feedstail -u http://hackeragenda.be/events/events.rss -i 5

默认输出格式可能不适合您。您可以使用 f 选项指定自己的格式。给定字段必须是订阅条目可用属性。以下示例将输出发布日期、标题和链接

$ feedstail -u http://hackeragenda.be/events/events.rss -f "{published}: {title} - {link}"

最后一个示例使用了Python 2.6版本中出现的字符串格式化语法。然而，feedstail 旨在与2.5版本兼容，因此您可以使用旧字符串格式化语法

$ feedstail -u http://hackeragenda.be/events/events.rss -f "%(published)s: %(title)s - %(link)s"

Feedstail比较id元素以找到新条目。您可以使用k选项选择另一个比较元素。以下示例指示feedstail使用标题来查找新条目

$ feedstail -u http://hackeragenda.be/events/events.rss -i 2 -k title

由于feedstail基于feedparser构建，因此格式字段和键的可用值可以在库文档中找到。

导入到其他Python项目

Feedstail可以通过以下方式导入到其他Python项目

from feedstail import feedGenerator
from feedstail.config import Config

选项

• key：比较键。默认：id

• reverse：布尔值，用于反转源中的条目。默认：False

• number：第一次显示x条条目。默认为None，显示所有收到的条目。

• ignore_key_error：布尔值，用于忽略键错误。默认：False

• no_endl：布尔值，用于忽略换行符。默认：False

• url：URL。默认：None

• format：条目的格式。

未提供的选项

• interval：检查源的时间间隔。

• one shot：一次性获取源。

feedGenerator接受Config实例作为参数并返回一个生成器。此生成器将返回一个条目数组（可能是空数组），格式由定义。

示例

from feedstail import feedGenerator
from feedstail.config import Config

feed = feedGenerator(Config(url="http://hackeragenda.be/events/events.rss", format=u'{title} - {link}'))
print '\n'.join(feed.next())

贡献！

• Fork项目：https://github.com/Psycojoker/feedstail.git

• 在分支上创建你的补丁

• 发送拉取请求或通过电子邮件发送你的补丁

不要忘记用以下标志之一标记你的提交

• [enh]：你的提交增加了一个显著的增强，例如一个新功能

• [fix]：你的提交是一个错误修复

• [doc]：你的提交改进了文档

• [mod]：你的提交带来了通用更改，不匹配上述任何一项，如重构