Dinghy 项目教程

Dinghy 项目教程

dinghy A GitHub activity digest tool 项目地址: https://gitcode.com/gh_mirrors/ding/dinghy

1. 项目的目录结构及介绍

Dinghy 项目的目录结构如下：

dinghy/
├── src/
│   └── dinghy/
│       ├── __init__.py
│       ├── main.py
│       └── ...
├── tests/
│   └── ...
├── .editorconfig
├── .gitignore
├── CHANGELOG.rst
├── LICENSE.txt
├── MANIFEST.in
├── Makefile
├── README.rst
├── dev-requirements.txt
├── pyproject.toml
└── ...

目录结构介绍

• src/dinghy/: 包含 Dinghy 项目的主要源代码。

  • __init__.py: 初始化文件，使该目录成为一个 Python 包。
  • main.py: 项目的启动文件。
  • 其他文件和目录：包含项目的其他功能模块和辅助文件。

• tests/: 包含项目的测试代码。

• .editorconfig: 配置文件，用于统一不同编辑器和 IDE 的代码风格。

• .gitignore: Git 忽略文件，指定哪些文件和目录不需要被 Git 跟踪。

• CHANGELOG.rst: 记录项目的变更日志。

• LICENSE.txt: 项目的许可证文件。

• MANIFEST.in: 指定在打包时需要包含的非 Python 文件。

• Makefile: 包含项目的构建和安装命令。

• README.rst: 项目的说明文档。

• dev-requirements.txt: 开发依赖文件，列出开发过程中需要的 Python 包。

• pyproject.toml: 项目的配置文件，包含项目的元数据和构建系统信息。

2. 项目的启动文件介绍

Dinghy 项目的启动文件是 src/dinghy/main.py。该文件包含了项目的入口函数，负责初始化项目并启动主要功能。

启动文件内容概述

• 导入模块: 导入项目所需的各种模块和库。
• 初始化配置: 读取配置文件，初始化项目的配置。
• 启动主程序: 根据配置启动 Dinghy 的主程序，开始生成 GitHub 活动摘要。

3. 项目的配置文件介绍

Dinghy 项目的配置文件是 dinghy.yaml。该文件用于配置 Dinghy 的行为，包括要生成的摘要内容、时间范围、目标仓库等。

配置文件内容概述

• digests: 定义要生成的摘要列表。

  • digest: 指定生成的 HTML 摘要文件名。
  • title: 摘要的标题。
  • since: 指定生成摘要的时间范围。
  • items: 指定要报告的活动项目，可以是 GitHub URL 或搜索查询。

• defaults: 设置默认配置，如忽略的用户列表。

示例配置文件

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

defaults:
  ignore_users:
    - app-user
    - fake-bot

通过以上配置，Dinghy 将生成三个不同的摘要文件，分别报告不同时间范围内的活动。

dinghy A GitHub activity digest tool 项目地址: https://gitcode.com/gh_mirrors/ding/dinghy