自动化IETF评论处理
项目描述
IETF评论处理器
处理来自IESG、多个董事局审查和AUTH48的评论对于文档作者来说可能很繁琐，因为评论数量庞大，并且以无结构的格式出现，需要手动处理。
此包安装了两个命令
ietf-comments以基于markdown的格式处理IESG和董事局的评论。rfced-comments处理来自RFC编辑器的RFC XML文件中的评论。
两者都可以用于为它们找到的评论创建GitHub问题。使用得当，它们可以帮助自动化以前繁琐的任务。
对于IESG和董事局的评论，此工具使用IETF评论Markdown格式，这是一个类似于ADs和董事局现在使用的半结构化格式。理想情况下，他们将以该格式创建评论以便于处理，即使他们不这样做，大多数评论也可以轻松转换为它进行处理。
在线验证器
如果您只需要验证Markdown评论，请参阅在线评论验证器。
安装
要安装ietf-comments，您需要Python 3.6或更高版本。然后，运行
pip3 install ietf-comments
注意：要使用rfced-comments，您需要Python 3.10或更高版本。为了确保使用Python 3.10，您可能需要使用类似以下命令：
python3.10 -m pip install ietf-comments
使用
处理AD和局务委员会评论
要验证AD或局务委员会审查是否符合IETF评论Markdown格式并查看识别出的问题，请运行：
ietf-comments filename
要为每个问题创建GitHub问题，请将您的环境中的GITHUB_ACCESS_TOKEN设置为GitHub个人访问令牌并运行：
ietf-comments -g owner/repo filename
... 其中owner/repo是存储库所有者和名称，由斜杠分隔。
如果您希望这些问题具有特定的标签，请运行：
ietf-comments -g owner/repo filename -l labelname
如果您希望添加适当的discuss、comment和nit labels，以及一个review标签，请传递-a：
ietf-comments -g owner/repo filename -a
处理RFC编辑评论
要验证本地RFC XML文件中的RFC编辑评论并查看识别出的问题，请运行：
rfced-comments filename
或者，如果您处于AUTH48状态且RFC编辑已发布了您的即将发布的RFC草案，您可以直接运行：
rfced-comments NNNN
其中NNNN是RFC编号。
要为每个问题创建GitHub问题，请将您的环境中的GITHUB_ACCESS_TOKEN设置为GitHub个人访问令牌并运行：
rfced-comments -g owner/repo NNNN_or_filename
... 其中owner/repo是存储库所有者和名称，由斜杠分隔。
如果您希望这些问题具有特定的标签，请运行：
rfced-comments -g owner/repo NNNN_or_filename -l labelname
特殊功能
以下功能目前受支持（更多即将推出！）
- 当识别出内部章节引用（例如，
第2.4节）时，将在创建的问题中自动创建链接。 - 同样，当识别出对外部RFC的引用（例如，
第5.3节[RFC1234]）时，将在创建的问题中自动创建链接。 - 评论中带块引用（以
>开头）的文本将被检查是否存在于文档中；如果没有找到，将发出警告。
下载文件
下载适用于您的平台的文件。如果您不确定选择哪个，请了解有关安装包的更多信息。
源分布
构建分布
ietf_comments-0.2.5.tar.gz的散列
| 算法 | 散列摘要 | |
|---|---|---|
| SHA256 | 257a47d8127c6adff15def3f39f2a7fe3ff8bceee0940f38e75cc53f7173feaf |
|
| MD5 | 4217c6e70eb65d902d38f0c777482dab |
|
| BLAKE2b-256 | 5d7581c84496a760ae1fe1a75e970d82d83fa3b12eb54425dc1ed99dc54ae0ca |