利用reddit API的一系列实用工具。
项目描述
# BBOE的PRAWtools
PRAWtools是通过[PRAW](https://praw.readthedocs.io/)使用reddit API的一系列工具。PRAWtools目前由三个实用工具组成
modutils
reddit_alert
subreddit_stats
## PRAWtools安装
### Ubuntu/debian安装
sudo apt-get install python-setuptools sudo easy_install pip sudo pip install prawtools
- ### Arch Linux安装
sudo pacman -S python-pip sudo easy_install pip sudo pip install prawtools
### Mac OS X安装
sudo easy_install pip sudo pip install prawtools
## modutils
modutils是一个辅助reddit社区管理员管理其社区的工具。目前，它主要用于从现有用户 flair 自动构建 flair 模板，但也可以用于快速列出被禁用户、贡献者和管理员。
### modutils示例
注意：所有示例都需要你是__foo__ subreddits的管理员
列出__foo__ subreddits的被禁用户
modutils -l banned foo
获取子版块 __bar__ 的当前 flair
modutils -f bar
0. 同步子版块 __baz__ 的 flair 模板与现有 flair，为至少两个用户共有的 flair 文本构建不可编辑的模板。
modutils –sync –ignore-css –limit=2 baz
0. 向子版块 __blah__ 的批准提交者发送消息。您将需要输入消息，并在发送消息之前进行验证。
modutils –message contributors –subject “消息主题” blah
## reddit_alert
reddit_alert 将在评论中使用特定关键词时通知您。例如，要始终在您的用户名被提及时收到通知，您可能可以这样运行：
reddit_alert bboe
您可以通过指定多个关键词以空格分隔来接收多个警报。如果您想对包含空格的关键词短语发出警报，必须在术语周围放置引号
reddit_alert bboe praw “reddit api”
默认情况下，reddit_alert 只会在其运行的同一终端屏幕（或命令提示符）中提供链接。要通过 Reddit 消息进行通知，请指定 -m USER 选项
reddit_alert -m bboe bboe praw “reddit_api”
使用 -m USER 时，您将需要登录。
默认情况下，考虑来自所有子版块的评论。如果您只想将通知限制在几个子版块中，请使用一个或多个 -s SUBREDDIT 选项
reddit_alert -m bboe -s redditdev -s learnpython bboe praw “reddit_api”
最后，您可能希望忽略某些用户的提醒。您可以使用 -I USER 选项忽略特定用户的评论
reddit_alert -m bboe -I bizarrobboe bboe
要查看所有可用选项，请运行
reddit_alert –help
## subreddit_stats
subreddit_stats 是一个工具，用于提供子版块的基本统计数据。要查看 subreddit_stats 生成的输出类型，请查看 [/r/subreddit_stats](http://www.reddit.com/r/subreddit_stats).
该工具将仅分析最多 1,000 个提交。
### 准备工作
为了运行 subreddit_stats，您需要在运行脚本的同一目录中创建一个 praw.ini 文件。该文件应如下所示
` [DEFAULT] client_id: XXX client_secret: XXX password: XXX username: XXX `
### subreddit_stats 示例
生成过去 30 天内子版块 __foo__ 的统计数据。
subreddit_stats foo 30
通过将数字 N 作为第二个参数传递，将获取过去 N 天的所有提交，但会忽略最近 24 小时内的提交。因此，您可能会收到类似“未找到提交”的消息。要分析过去一个月内制作的顶级提交，请运行
subreddit_stats foo month
同样，要分析过去一年中 __foo__ 的顶级提交，请运行
subreddit_stats foo year
要查看其他可能选项
subreddit_stats –help
下载文件
下载适合您平台的文件。如果您不确定该选择哪个，请了解更多关于安装包的信息。