小艇每日摘要工具
项目描述
Dinghy，一个 GitHub 活动摘要工具。
Dinghy 使用 GitHub GraphQL API 来查找有关问题和拉取请求的最新活动，并编写一个紧凑的 HTML 摘要，如下所示。
入门
安装小艇：
$ python -m pip install dinghy要运行 dinghy，您需要一个具有正确范围的 GitHub个人访问令牌，可能是“repo”。创建一个并使用值定义 GITHUB_TOKEN 环境变量：
$ export GITHUB_TOKEN=ghp_Y2oxDn9gHJ3W2NcQeyJsrMOez
然后使用 GitHub URL 运行 dinghy：
$ python -m dinghy https://github.com/Me/MyProject Wrote digest: digest.html您将在摘要.html 中获得回购上周活动的摘要。它看起来像这样。
您还可以编写一个 YAML 配置文件来消化多个来源，或者具有不同的时间段。
配置
Dinghy 配置从 YAML 文件（默认为dinghy.yaml）中读取。这是一个例子：
digests:
- digest: lastweek.html
title: My projects last week
since: 1 week
items:
- https://github.com/orgs/myorg/projects/17
- https://github.com/orgs/anotherorg/projects/8
- https://github.com/myorg/myrepo/pulls
- digest: hotnews.html
title: Today's news
since: 1 day
items:
- url: https://github.com/orgs/anotherorg/projects/8
home_repo: anotherorg/wg
- https://github.com/myorg/churnchurn/issues
- digest: all_prs.html
since: 1 day
items:
- search: org:myorg is:pr
title: MyOrg pull requests
defaults:
ignore_users:
- app-user
- fake-bot摘要子句是要生成的摘要列表。defaults 子句为文件其余部分的摘要选项设置默认值。每个 摘要子句都指定要消化的内容：
摘要设置是要写入的 HTML 摘要文件。
since设置指示回溯到多远的位置寻找活动。它可以使用周、天、小时、分钟和秒的单位，也可以缩写，如1d6h。
items设置是要报告的内容列表，以几种不同的方式指定：
url设置是一个 GitHub URL ，有多种形式：
组织项目 URL 将报告项目中的问题和拉取请求。您的 GitHub 令牌将需要“read:project”范围。
回购的 URL 将报告回购中的问题和拉取请求。
回购问题的 URL 将报告回购中的问题。
存储库拉取请求的 URL 将报告存储库中的拉取请求。
这些 URL 中的任何一个都可以指向 GitHub Enterprise 安装而不是https://github.com。
搜索设置可以指定 GitHub 搜索查询来查找问题或拉取请求。该查询将添加一个updated:术语以说明since:设置。
如果一个项目只需要指定一个 GitHub URL，那么它可以简单地是 URL 字符串。
可选的标题设置将用于构造 HTML 页面的标题和主标题。
对于 GitHub Enterprise，您可以指定api_root，这是构建 GraphQL API 请求的 URL。它默认为“ https://api.github.com/graphql ”。
项目可以有其他选项：
没有为 bot 用户报告任何活动。一些应用程序充当真实用户，但无论如何都应该被忽略。您可以在ignore_users设置中列出那些应该被忽略的用户名。
项目可以有一个明确的标题集，标题为：设置。
组织项目的选项包括：
home_repo是将在其中创建大多数问题的存储库的所有者/存储库。其他回购中的问题将在摘要中指示回购。
变更日志
未发布
查看scriv.d 目录中的片段文件。
0.13.2 — 2022-08-13
固定的
添加 HTML <meta>标记以确保内容正确解码为 UTF-8。修复问题 12。谢谢，比尔米尔。
0.13.1 — 2022-08-03
固定的
在 Windows 上，完成时会出现一个令人震惊但无害的错误。现在已修复，关闭问题 9。谢谢，卡尔顿吉布森。
0.13.0 — 2022-07-29
已移除
删除了已弃用的“pull_requests”设置。
添加
api_root设置允许 GitHub Enterprise 用户控制要使用的 GraphQL 端点。
改变了
适应2022-06-23 GitHub 问题更新，使用 ProjectsV2 API 而不是 ProjectsNext API。
0.12.0 — 2022-06-12
添加
标题选项可用于单个摘要以向报告标题添加文本。谢谢，道格·赫尔曼。
0.11.5 — 2022-06-07
固定的
已关闭的问题现在区分“已完成”和“未计划”。
0.11.4 — 2022-05-10
添加
HTML 转义应用于从 GitHub 提取的文本（哎呀！）
表情符号显示为表情符号而不是文本。
0.11.3 — 2022-05-06
固定的
GitHub 有时会回复“502 Bad Gateway”。如果发生这种情况，请暂停并重试。
0.11.2 — 2022-04-12
添加
添加了--version选项。
固定的
带有许多评论的拉取请求会跳过一些评论。现在所有拉取请求数据都已完全检索。
在大型摘要中，GitHub 有时会返回 403 作为速率限制。发生这种情况时重试以完成查询。
0.11.1 — 2022-03-29
固定的
更正了打包错误（缺少变更日志条目）。
0.11.0 — 2022-03-29
添加
已解决的评论现在用复选框图标指示，并悬停“已解决的评论”文本。
固定的
修复了尝试获取项目中问题的存储库的崩溃。
0.10.0 — 2022-03-28
改变了
拉取请求数据未正确显示：评论未包含在本应包含的摘要中。
如果需要显示较新评论的讨论线程，则将包含早于截止日期的拉取请求评论。旧评论以灰色显示，以帮助您专注于最近的活动。
对持续时间的解析更加严格，因此“1 个月”不会被误认为“1 分钟”。修复问题 7
已移除
糟糕，事实证明没有“Projects (beta)”的 repo 项目。那个不起作用的东西已经被删除了。
0.9.0 — 2022-03-17
添加
GitHub 企业支持：您可以使用指向您自己的 GitHub Enterprise 安装的 URL。只能使用单个主机。谢谢，亨利·格索。
配置文件中的“搜索：”条目将查找与查询匹配的问题或拉取请求。
配置文件中的项目可以有标题：设置明确的标题。
已弃用
不推荐使用pull_requests:配置设置以支持 search:。 pull_requests: org:my_org变成search: org:my_org is:pr。
0.8.0 — 2022-03-16
添加
支持回购项目。
固定的
某些错误的错误处理失败。现在已修复，关闭 问题 4。
0.7.1 — 2022-03-13
固定的
更好地处理授权问题，并显示错误消息，以便用户可以修复它们。
0.7.0 — 2022-03-12
添加
命令行现在接受 GitHub URL，以快速从 repo（或问题、拉取请求等）中获取一周的活动摘要。
现在可以使用-v / --verbosity 命令行选项指定日志记录级别。
固定的
依赖项现在具有最少的引脚，修复了问题 1。
0.6.0 — 2022-03-10
添加
GitHub 的 @ghost 用户在 GraphQL 结果中显示为 None 的“作者”。妥善处理该案。
固定的
修复了标签的颜色。
正确处理正文中的 HTML。
0.5.2 — 2022-03-08
改变了
对缩进和信息的更多 HTML 调整。
0.5.1 — 2022-03-07
改变了
缩进调整使线程结构更清晰。
0.5.0 — 2022-03-03
改变了
拉取请求评论显示得更紧凑。
0.4.0 — 2022-02-28
添加
回购 URL 将报告回购中的拉取请求和问题。
0.3.0 — 2022-02-27
添加
可以将配置文件指定为命令行上的参数。
GitHub 图标装饰拉取请求、问题和评论以区分它们并指示它们的状态。
改变了
配置文件语法已更改。现在有一个顶级摘要 子句和一个可选的默认子句。
bots设置现在称为ignore_users。
拉取请求审查线程按层次结构呈现。
0.2.0 — 2022-02-21
添加
项目可以有选项。组织项目有一个home_repo选项，因此来自其他 repo 的问题将得到另一个 repo 的指示。
可以在组织中搜索拉取请求。
如果小艇达到 GraphQL API 速率限制，它将休眠，直到限制被重置。
不要报告机器人用户的活动。bot设置可用于列出应视为 bot 的用户帐户。
0.1.0 — 2022-02-19
第一次发布。
下载文件
下载适用于您平台的文件。如果您不确定要选择哪个，请了解有关安装包的更多信息。
源分布
内置分布
dinghy- 0.13.2 -py2.py3-none-any.whl 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 9cdf1092d9f8d0069ca79ea07cd41e71c87832df551892fe7267a48e88749efb |
|
| MD5 | 817e6d541d85c5636eda8bdffc4a7fd7 |
|
| 布莱克2-256 | 112d0673ae942c18a3b3af7177d940ac6590645df120d717de10e866fa871bf3 |