Skip to main content

Python class for reading and writing data to a GitHub repository

Project description


PyPI Changelog Tests License

Read and write both small and large files to Github.

The regular GitHub Contents API can't handle files larger than 1MB - this class knows how to spot that problem and switch to the large-file-supporting low level Git Data API instead.

Note that file contents is passed and returned as bytestrings, not regular strings.


pip install github-contents


You will need a GitHub OAuth token with full repository access.

The easiest way to create one of these is using

from github_contents import GithubContents

# For repo simonw/disaster-data:
github = GithubContents(

To read a file:

content_in_bytes, sha =

To write a file:

content_sha, commit_sha = github.write(
    sha=previous_sha, # Optional
        "name": COMMITTER_NAME,
        "email": COMMITTER_EMAIL,

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

github-contents-0.2.tar.gz (3.6 kB view hashes)

Uploaded source

Built Distribution

github_contents-0.2-py3-none-any.whl (3.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page