github-contents

读取和写入Github中的小文件和大文件。

常规的GitHub内容API无法处理大于1MB的文件 - 这个类知道如何识别这个问题，并切换到支持大文件的低级Git数据API。

注意，文件内容作为字节串传递和返回，而不是常规字符串。

安装

pip install github-contents

使用

您需要一个具有完整仓库访问权限的GitHub OAuth令牌。

创建一个的最简单方法是使用https://github.com/settings/tokens

from github_contents import GithubContents

# For repo simonw/disaster-data:
github = GithubContents(
    "simonw",
    "disaster-data",
    token=GITHUB_OAUTH_TOKEN,
    branch="main"
)

读取文件

content_in_bytes, sha = github.read(path_within_repo)

写入文件

content_sha, commit_sha = github.write(
    filepath=path_within_repo,
    content_bytes=contents_in_bytes,
    sha=previous_sha, # Optional
    commit_message=commit_message,
    committer={
        "name": COMMITTER_NAME,
        "email": COMMITTER_EMAIL,
    },
)