ACCESS_TOKEN

USERNAME

REPOSITORY

PULL_NUMBER

RELEASE_ID

DEPLOYMENT_ID

Get hands-on with GitHub APIs in Python. Learn to manage repositories, branches, and commits. Build a demo app integrated with GitHub. Confidently build in-demand skills.

Managing Your Codebase with the GitHub API in Python.png

GitHub.tar.gz

demo-app

GitHub is one of the most popular code management platforms for software engineers. Developers can use Git to create and edit both personal and shared repositories, control access, and fork projects into various branches. These changes are approved by collaborators and merged back into the main branch before a final release.

This course will walk you through various GitHub APIs and their endpoints. You’ll be introduced to authentication and integration with a GitHub developer account to leverage the APIs to manage your code. Next, you’ll learn to manage repositories, branches, commits, projects, collaborators, and more. By the end of this course, you’ll be able to build a demo application integrated with GitHub APIs.

Managing Your Codebase with the GitHub API in Python

# Overview

Being a distributed version control manager, GitHub allows the feature of creating pull requests through which we can share our changes committed to a branch with the contributors. These contributors can then review and add comments for any feedback or changes. The changes can be addressed by adding follow-up commits to that branch. We can also add descriptions of the proposed changes, add labels, add reviewers and assignees, and mention people. Additionally, we can review comments or commits made in that branch in chronological order. Once finalized, the reviewers then approve these changes and then that branch is merged into the base branch.

headers = {
    'Authorization': 'token {{ACCESS_TOKEN}}',
    'Accept': 'application/vnd.github.v3+json'
}

data = json.dumps({
    'title': '<title>',
    'head': '<head-name>',
    'base': '<base-name>'
})

url='https://api.github.com/repos/{{USERNAME}}/{{REPOSITORY}}/pulls'

response = requests.post(url, headers=headers, data=data)
print(json.dumps(response.json(), indent=4))

Parameters for creating a pull request

align-center

headers = {
    'Authorization': 'token {{ACCESS_TOKEN}}',
    'Accept': 'application/vnd.github.v3+json'
}

url='https://api.github.com/repos/{{USERNAME}}/{{REPOSITORY}}/pulls/{{PULL_NUMBER}}'

response = requests.get(url, headers=headers)
print(json.dumps(response.json(), indent=4))

## List pull requests

This endpoint lists all the pull requests made in a repository.

headers = {
    'Authorization': 'token {{ACCESS_TOKEN}}',
    'Accept': 'application/vnd.github.v3+json'
}

url= 'https://api.github.com/repos/{{USERNAME}}/{{REPOSITORY}}/pulls'

response = requests.get(url, headers=headers)
print(json.dumps(response.json(), indent=4))

## List commits on a pull request

The commits on a pull request can be listed through this pull request endpoint. However, a maximum of 250 commits can be listed through this. If we want to retrieve all the commits, we should do it through the "list commits" endpoint.

headers = {
    'Authorization': 'token {{ACCESS_TOKEN}}',
    'Accept': 'application/vnd.github.v3+json'
}

url= 'https://api.github.com/repos/{{USERNAME}}/{{REPOSITORY}}/pulls/{{PULL_NUMBER}}/commits'

response = requests.get(url, headers=headers)
print(json.dumps(response.json(), indent=4))

## Merge a pull request

When we make a pull request in the _head_ branch, it gets approved and is then merged back into the main branch known as the _base_.

headers = {
    'Authorization': 'token {{ACCESS_TOKEN}}',
    'Accept': 'application/vnd.github.v3+json'
}

data = json.dumps({
    'commit_title': '<title>'
})

url= 'https://api.github.com/repos/{{USERNAME}}/{{REPOSITORY}}/pulls/{{PULL_NUMBER}}/merge'

response = requests.put(url, headers=headers, data=data)
print(json.dumps(response.json(), indent=4))

## Check if a pull request has been merged

Now that we’ve merged a pull request, let’s check whether or not the pull request was merged by providing its ID in the path.

> **Note:** This endpoint only outputs the pull request once it is merged.

headers = {
    'Authorization': 'token {{ACCESS_TOKEN}}',
    'Accept': 'application/vnd.github.v3+json'
}

url='https://api.github.com/repos/{{USERNAME}}/{{REPOSITORY}}/pulls/{{PULL_NUMBER}}/merge'

response = requests.get(url, headers=headers)
print(response)

Learn and practice the functionalities of pull requests in the GitHub API.

Introduction

Code Management

Collaboration

Deployment

APIs Integration in Django

Conclusion

Pull Requests