用于向github存储库读写数据的python类
github-contents的Python项目详细描述
GitHub内容
将大小文件读写到github。
常规的GitHub Contents API不能处理大于1MB的文件-这个类知道如何发现这个问题并切换到支持低级Git Data API的大文件。
注意,文件内容是作为bytestrings传递和返回的,而不是常规字符串。
用法
您需要一个具有完全存储库访问权限的github oauth令牌。
创建其中一个的最简单方法是使用https://github.com/settings/tokens
# For repo simonw/disaster-data:github=GithubContents("simonw","disaster-data",GITHUB_OAUTH_TOKEN)
读取文件:
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,# Optionalcommit_message=commit_message,committer={"name":COMMITTER_NAME,"email":COMMITTER_EMAIL,},)