plumes 2.3.2

羽流

用于日常社交媒体卫生的简单 Twitter CLI
· 报告错误 · 请求功能

内容

• 内容
• 概述
• 灵感
• 安装
• 用法
  • 开始并创建您的身份验证配置
  • 出口朋友
  • 导出关注者
  • 导出推文
  • 审核用户
  • 修剪你的推文
• 设置身份验证
  • 获取您的 Twitter API 令牌
  • 配置plumes
• 贡献
• 测试

概述

Plumes是一个用于日常社交媒体卫生的开源 Python CLI 应用程序。它旨在提供一个简单、清晰、简洁的界面，以快速浏览和清理个人 Twitter 帐户。

灵感

安装

# python >=3.6.1 is required
pip install plumes

用法

开始并创建您的身份验证配置

# create your config file
plumes init

# validate your config file
plumes check_config

# print your config file (watch out for sensitive tokens!)
plumes view_config

出口朋友

提取添加好友的命令：

plumes friends <flags>

# e.g., get the friends of Steve Martin (see data in examples dir)
plumes friends SteveMartinToGo --limit 100

论据：

• screen_name Optional[str], optional - 目标用户的屏幕名称（即 Twitter 句柄）。如果没有给出，则使用经过身份验证的用户。默认为无。
• limit Optional[int], optional - 要获取的最大用户数。默认为无。
• output Optional[str], optional - JSON 文件的输出路径。默认为无。

导出关注者

提取他们被添加的顺序的追随者：

plumes followers <flags>

# e.g., get the followers of Al Yankovic (see data in examples dir)
plumes followers alyankovic --limit 100

论据：

• screen_name Optional[str], optional - 目标用户的屏幕名称（即 Twitter 句柄）。如果没有给出，则使用经过身份验证的用户。默认为无。
• limit Optional[int], optional - 要获取的最大用户数。默认为无。
• output Optional[str], optional - JSON 文件的输出路径。默认为无。

导出推文

提取（和存档）按最近排序的推文：

plumes tweets <flags>

# e.g., get the tweets of Conan O'Brien (see data in examples dir)
plumes tweets ConanOBrien --limit 100

论据：

• screen_name Optional[str], optional - 目标用户的屏幕名称（即 Twitter 句柄）。如果没有给出，则使用经过身份验证的用户。默认为无。
• limit Optional[int], optional - 要获取的最大用户数。默认为无。
• output Optional[str], optional - JSON 文件的输出路径。默认为无。

审核用户

审核和审查用户给定的标准。使用它来大规模关注/取消关注许多用户。

plumes audit_users PATH <flags>

# e.g., follow 100 of Al Yankovic's followers
plumes followers alyankovic --limit 100
plumes audit_users alyankovic-followers.json --befriend

# e.g., prune (i.e., unfollow) current friends who have less than 100 followers AND haven't tweeted in the last 30 days
plumes friends --output "friends.json"
plumes audit_users "friends.json" --prune --min_followers 100 --days 30

论据：

• path str - 用户 JSON 文件的路径（例如，friends() 的输出）
• min_followers Optional[int], optional - 最小关注者数量。默认为无。
• max_followers Optional[int], optional - 最大关注者数。默认为无。
• min_friends Optional[int], optional - 最少朋友数。默认为无。
• max_friends Optional[int], optional - 最大好友数。默认为无。
• days Optional[int], optional - 自上次推文以来的天数。默认为无。
• min_tweets Optional[int], optional - 推文的最小数量。默认为无。
• max_tweets Optional[int], optional - 最大推文数。默认为无。
• min_favourites Optional[int], optional - 收藏夹的最小数量。默认为无。
• max_favourites Optional[int], optional - 收藏的最大数量。默认为无。
• min_ratio Optional[float], optional - 最小 Twitter 关注者-朋友 (TFF) 比率。默认为无。
• max_ratio Optional[float], optional - 最大 Twitter 关注者-朋友 (TFF) 比率。默认为无。
• prune bool，可选- 取消关注已识别的用户。默认为假。
• befriend bool，可选- 关注已识别的用户。默认为假。
• bool_or bool，可选- 切换到布尔或条件。默认为假。

修剪你的推文

审核和审查给定标准的推文。使用它来批量收藏或删除推文。

plumes audit_tweets PATH <flags>

# e.g., delete your tweets that are older than 60 days AND that you didn't self-favourite
plumes tweets --output "tweets.json"
plumes audit_tweets "tweets.json" --prune --days 60 --self_favorited False

# e.g., export 100 of Conan O'Brien's tweets and favourite those that have a maximum of 10 likes and a minimum of 50 retweets
plumes tweets ConanOBrien --limit 100
plumes audit_tweets ConanOBrien-tweets.json --favorite --max_likes 10 --min_retweets 50

论据：

• days Optional[int], optional - 自发推文以来的天数。默认为无。
• min_likes Optional[int], optional - 收藏夹的最小数量。默认为无。
• max_likes Optional[int], optional - 收藏的最大数量。默认为无。
• min_retweets Optional[int], optional - 转发的最小数量。默认为无。
• max_retweets Optional[int], optional - 最大转发数。默认为无。
• min_ratio Optional[float], optional - 最小 Twitter 点赞转发率。默认为无。
• max_ratio Optional[float], optional - 最大 Twitter 点赞转发率。默认为无。
• self_favorited Optional[bool], optional - 检查推文是否是自喜欢的。默认为无。
• prune bool，可选- 修剪和销毁已识别的推文。默认为假。
• favorite bool，可选- 喜欢已识别的推文。默认为假。
• bool_or bool，可选- 切换到布尔或条件。默认为假。

设置身份验证

获取您的 Twitter API 令牌

• 导航到Twitter 开发门户

• 点击Create an app

  

• 填写表格

• 导航Keys and tokens

  

• 复制API key、API secret key、Access token和的值Access token secret

  

配置plumes

API 令牌可以设置为环境变量（使用PLUMES_前缀；例如，export PLUMES_CONSUMER_KEY=xxxxx）或配置变量~/.plumes.toml：

• CONSUMER_KEY =<API key>
• CONSUMER_SECRET =<API secret key>
• 访问令牌 =<Access token>
• ACCESS_TOKEN_SECRET =<Access token secret>

贡献

请参阅CONTRIBUTING.md行为准则以了解如何为项目做出贡献

测试

• 请查看Makefile所有可用测试的概述
• 下面突出显示最重要的测试和make命令：

# auto-format code
make format

# perform all static tests
make check