DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Refcards Trend Reports Events Over 2 million developers have joined DZone. Join Today! Thanks for visiting DZone today,
Edit Profile Manage Email Subscriptions Moderation Admin Console How to Post to DZone Article Submission Guidelines
View Profile
Sign Out
Refcards
Trend Reports
Events
Zones
Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Partner Zones AWS Cloud
by AWS Developer Relations
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Partner Zones
AWS Cloud
by AWS Developer Relations
Building Scalable Real-Time Apps with AstraDB and Vaadin
Register Now

Trending

  • Best Practices for Securing Infrastructure as Code (Iac) In the DevOps SDLC
  • Top Six React Development Tools
  • RAML vs. OAS: Which Is the Best API Specification for Your Project?
  • Which Is Better for IoT: Azure RTOS or FreeRTOS?

Trending

  • Best Practices for Securing Infrastructure as Code (Iac) In the DevOps SDLC
  • Top Six React Development Tools
  • RAML vs. OAS: Which Is the Best API Specification for Your Project?
  • Which Is Better for IoT: Azure RTOS or FreeRTOS?
  1. DZone
  2. Testing, Deployment, and Maintenance
  3. Deployment
  4. PyGitHub Quickstart Examples

PyGitHub Quickstart Examples

Helpful examples can make up for a lack of documentation. In this article, Chase Seibert shares some of his example code.

Chase Seibert user avatar by
Chase Seibert
·
Nov. 24, 16 · Opinion
Like (1)
Save
Tweet
Share
9.18K Views

Join the DZone community and get the full member experience.

Join For Free

PyGitHub is the most popular GitHub API SDK for Python. Their documentation is very light on examples. They seem to think that this is fine. This makes for a prime candidate for the new Stack Overflow Documentation site!

In the meantime, I thought I would share my example code. These took me an hour of playing with the REPL to figure out.

Working With Pull Requests

The main challenge here was realizing that I needed to scope everything to my private org, not my user.

git = PyGithub('GITHUB_TOKEN')
org = git.get_organization('OrgName')
repo = org.get_repo('repo-name')
pr = repo.get_pull(1)
print 'PR author: %s' % pr.user.login
comments = pr.get_issue_comments()
for comment in comments:
  print 'Comment: ', comment.created_at, comment.user.login, comment.body
pr.create_issue_comment('Comment from GITHUB_TOKEN user') # aka git.get_user()

Getting the Contents of a File

From the default branch, not a particular pull request.

git = PyGithub('GITHUB_TOKEN')
org = git.get_organization('OrgName')
repo = org.get_repo('repo-name')
file_contents = repo.get_file_contents('path/to/file')

Listing the Members of a GitHub Team

There is no method to get a team by name, so you need to get them all and then pick out the one you want.

git = PyGithub('GITHUB_TOKEN')
org = git.get_organization('OrgName')
teams = org.get_teams()
team = [t for t in teams if t.name == 'TeamName'][0]  # assumes a match
print [m.login for m in team.get_members()]
Stack overflow pull requests teams GitHub Documentation Requests PRIME (PLC) Python (language) Branch (computer science)

Published at DZone with permission of Chase Seibert, DZone MVB. See the original article here.

Opinions expressed by DZone contributors are their own.

Trending

  • Best Practices for Securing Infrastructure as Code (Iac) In the DevOps SDLC
  • Top Six React Development Tools
  • RAML vs. OAS: Which Is the Best API Specification for Your Project?
  • Which Is Better for IoT: Azure RTOS or FreeRTOS?

Comments

Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com

Let's be friends: