How to use GitHub API in python to read and update an existing README.md file in a repository?

Question

I have an existing README.md file in a github repository. How can I update the README.md file through a python script using github API? I guess the API states that we can get contents for a file. I want to know how do I add markdown text to the content, overwrite the README.md file and add it to the repository as a commit from within the python script using the API.

mehtaarn000 · Accepted Answer · 2020-12-02 05:33:28Z

1

Use the PyGitHub module, which is a python wrapper for the GitHub api.

from github import Github

# Authenticate yourself 
g = Github("yourusername", "yourauthtoken")

# Find your repository and path of README.md
repo=g.get_user().get_repo("your repo")
file = repo.get_contents("README.md")

# The new contents of your README.md
content = "your updated README file contents"

# Update README.md
repo.update_file("README.md", "commit message", content, file.sha)

answered Dec 2, 2020 at 5:33

mehtaarn000

5921 gold badge7 silver badges13 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

ragethewolf Over a year ago

Won't this replace the existing data with new data is there a way to append the new data and not impact the existing data.

Collectives™ on Stack Overflow

How to use GitHub API in python to read and update an existing README.md file in a repository?

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related