介绍

github-track 是一个使用Github API v3的 Python 库。有了它，您可以从 Python 脚本中拉取任何公共存储库拉取请求。发送电子邮件目前仅适用于 sendGrid 完整的文档可以在这里找到github-track full docs 在文档的示例部分，您可以了解如何将配置文件解析到模块等等。

下载并安装

首先确保你已经在你的机器上安装了 python 并且版本高于3.6. 如果不是，请按以下步骤进行安装。

brew install python@3.9

使用 pip 安装

最简单的安装方法是使用 Python Package Index，因此，一个 pip install 就足够了。

pip3 install GhTrack

克隆源代码安装 如果你使用 pip 安装过，可以忽略这部分。要使用它，请克隆github-track存储库。

git clone https://github.com/zinaLacina/github-track

一旦它克隆，请 cd 进入目录

cd  github-track

进入方向后，检查您是否拥有最新的 setuptools。

python3 -m pip install --upgrade setuptools

最后安装模块

python3 setup.py install

你已经准备好运行应用程序了。

简短教程

让我们测试该模块的基本功能，包括拉取公共回购的最后 7 天拉取请求。默认情况下，模块在数据文件夹中的设置中具有默认值。默认仓库是kubernetes. kubernetes因此，要获取repo的最后 7 天拉取请求的列表。

打开一个终端，然后在控制台中输入。

>> python3

之后，导入GhTrack模块

>> from ghtrack.GhTrack import GhTrack
# create GhTrack object without any params(first of all the default params)
>> g = GhTrack() 
#Print on the console the html of the last 7 days pull requests 
>> g.sendEmailOrPrintConsole(emailNotConsole=False)

还可以获取最近 7 天拉取请求的 json 格式

>> from ghtrack.GhTrack import GhTrack 
>> g = GhTrack() 
>> pulls = g.getPulls()
#Print the json format 
>> pulls

然后玩你的 GhTrack 对象：

>> for pull in pulls:
>> ...print(pull["title"])

许可

这是发布到公共领域的免费且不受限制的软件。

任何人都可以出于任何商业或非商业目的，以任何方式自由复制、修改、发布、使用、编译、销售或分发此软件，无论是源代码形式还是编译后的二进制文件。在承认版权法的司法管辖区，本软件的作者将本软件的所有版权权益奉献给公共领域。我们做出这种奉献是为了广大公众的利益，不利于我们的继承人和继任者。我们希望这种奉献是一种公开的行为，即永久放弃根据版权法对本软件的所有当前和未来权利。

本软件按“原样”提供，不提供任何形式的明示或暗示保证，包括但不限于适销性、特定用途适用性和非侵权保证。在任何情况下，作者均不对任何索赔、损害或其他责任承担责任，无论是在合同诉讼、侵权行为或其他方面，由软件或软件中的使用或其他交易引起、与之相关或与之相关。

更多信息请参考< https://unlicense.org >