使用Github API,将Github打造成一个稳定、便捷的网络数据中转站

桃扇骨 2022-11-20 09:35 335阅读 0赞

# 前言 #

github作为一个稳定的代码托管库其实是可以当做免费数据中转站使用，实现数据的存储、自动更新、访问等等。

更为可喜的是，目前有现成的python库完成了github api的封装，我们直接使用 已经封装好的库就可以了。

本人使用的是：Pygithub, 项目使用文档：https://pygithub.readthedocs.io/en/latest/introduction.html

这个方法也可以用来做github的爬虫，自动化访问github的公开项目的内容。

# 库的安装方法： #

pip3 install pygithub

# 库的使用方法： #

## 申请access token ##

要使用github API,首先需要拥有github的账号，或者github的access token。github账号密码是比较好获取的，但是这个不安全，很容易不小心把用户名密码泄露给其他人；因此，我们还是推荐使用access token来访问gitHub API,而且这个 access\_token也好管理。

首先进入github的设置界面，点击“Developper setting”

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ptaDE5OTY_size_16_color_FFFFFF_t_70_pic_center]然后选择 personal access token,  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ptaDE5OTY_size_16_color_FFFFFF_t_70_pic_center 1]  
点击“Generate new token”，创建新的access\_token。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ptaDE5OTY_size_16_color_FFFFFF_t_70_pic_center 2]  
选择所需的权限，然后给它起个名字，这里我们就只选择代码仓库的全部权限。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ptaDE5OTY_size_16_color_FFFFFF_t_70_pic_center 3]  
选择好后点击最下面的生成按钮，然后就可以看到生成的access\_token了。  
把这个access\_token保存好，再次刷新github后这个串就不再显示了，如果遗忘的话只能重新申请了。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ptaDE5OTY_size_16_color_FFFFFF_t_70_pic_center 4]

## 使用API ##

### 登录Github ###

__author__ = 'jmh081701'
    from github import Github
    import config
    git = Github(login_or_token=config.config['access_token'])

### 访问Github仓库 ###

##得到指定仓库
    repo = git.get_repo("jmhIcoding/datastore")
    ##输出仓库的一些信息
    ##输出主题
    print(repo.get_topics())
    ##显示这个仓库的stars数目
    print(repo.stargazers_count)

### 【查】指定Github仓库的指定文件 ###

contents= repo.get_contents(path="README.md")

如果文件不存在，执行这个函数会抛出异常：

github.GithubException.UnknownObjectException: 404 { "message": "Not Found", "documentation_url": "https://docs.github.com/rest/reference/repos#get-repository-content"}

否则，返回是一个`github.ContentFile.ContentFile` 对象。  
这个对象里面的一些重要的方法和属性：

<table> 
 <thead> 
  <tr> 
   <th>属性名</th> 
   <th>含义</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>type</td> 
   <td>文件类型，取值：file或dir</td> 
  </tr> 
  <tr> 
   <td>size</td> 
   <td>文件大小</td> 
  </tr> 
  <tr> 
   <td>name</td> 
   <td>文件名</td> 
  </tr> 
  <tr> 
   <td>path</td> 
   <td>文件的路径</td> 
  </tr> 
  <tr> 
   <td>content</td> 
   <td>文件内容，被base64编码后的结果</td> 
  </tr> 
  <tr> 
   <td>decoded_content</td> 
   <td>文件内容，经过base64解码后的结果</td> 
  </tr> 
  <tr> 
   <td>download_url</td> 
   <td>文件的下载链接</td> 
  </tr> 
 </tbody> 
</table>

访问一下：

print(contents.type)
    print(contents.size)
    print(contents.name)
    print(contents.path)
    print(contents.content)
    print(contents.decoded_content)
    print(contents.download_url)

输出结果：

file
    40
    README.md
    README.md
    IyBkYXRhc3RvcmUK5Z+65LqOZ2l0aHVi55qE5pWw5o2u5Lit6L2sCg==
    
    b'# datastore\n\xe5\x9f\xba\xe4\xba\x8egithub\xe7\x9a\x84\xe6\x95\xb0\xe6\x8d\xae\xe4\xb8\xad\xe8\xbd\xac\n'
    https://raw.githubusercontent.com/jmhIcoding/datastore/main/README.md?token=AESR3WOCTZT5A4OAY5637W27TDPYK

如果文件的内容是中文的话，base64解码后，注意使用utf在解码一次。

print(base64.b64decode(contents.content).decode('utf8'))

输出：

# datastore
    基于github的数据中转

### 【增】 增加新的Github文件 ###

填上文件路径path,提交的信息：message，和内容就可以了。  
注意message最好不要有空格

repo.create_file(path="test.txt",message="commit_msg",content='test content')

执行后，我们看到仓库已经有这个文件了：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ptaDE5OTY_size_16_color_FFFFFF_t_70_pic_center 5]  
另外 文件路径，不支持新建文件夹。

### 【改】 修改Github文件内容 ###

先获取文件，然后再调用update\_file函数。

content = repo.get_contents('test.txt')
    repo.update_file(path=content.path,message='update_msg',content='new content',sha=content.sha)

注意里面的sha参数，使用content.sha来获取，这个sha填被替换文件的哈希值，这是在做进一步的确认。

### 【删】 删除Github文件 ###

先获取文件，再删除

content = repo.get_contents("text.txt")
    repo.delete_file(path=content.path,message='delete',sha=content.sha)

上面的get\_contents函数，都可以接“ref”参数，这个参数的作用是指明这个文件是那个分支、tag的， 默认是master分支。

> The name of the commit/branch/tag. Default: the repository’s default branch (usually master)

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ptaDE5OTY_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/c80c81594f3a41138568c526c51d0c71.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ptaDE5OTY_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221120/7de58d72d1c54dcea710440894a73418.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ptaDE5OTY_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221120/b9f48eadd2ac4b008008721eff36b15d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ptaDE5OTY_size_16_color_FFFFFF_t_70_pic_center 3]: /images/20221120/4e8b1f120a63487d93d1cff290ec6c40.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ptaDE5OTY_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20221120/fd6b6d3ca2bd4e51942ddc65c49604e6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2ptaDE5OTY_size_16_color_FFFFFF_t_70_pic_center 5]: /images/20221120/c981d94861e145bda11db81f579d264c.png