PyGithub example usage #874

sfdye · 2018-08-21T08:24:38Z

PyGithub is a great library, however it may not be intuitive to use at the beginning. Not everyone is a Github API expert, so I am trying to provide some working examples (recipes) that will hopefully help you get started.

The skeleton has been setup here and the example docs is already live on readthedocs as usual:

https://pygithub.readthedocs.io/en/latest/examples.html

Note that the list will expand and any PR to add more examples is extremely welcome 😄

If you want to see any examples not covered here, just leave a comment.

Abdur-rahmaanJ · 2018-08-21T09:40:31Z

@sfdye readd the login example please ^^_

use repr to display objects

This PR add the follow code examples * Issue examples (get list, get specific issue, create issue) * Milestone examples (get list, get specific milestone, create milestone) Ref.: #874

## What does this change do? Adds a small example of how to get at the date a commit took place. ### Changes #### doc/examples/Commit.rst Adds a block of code that demonstrates how to get at a commit's date. ## Motivation This example is in the spirit of #874. When I began using PyGithub it was not readily apparent to me where the commit date was being abstracted to. Being unfamiliar with Git's API, it took some convincing for me to be satisfied that the `Commit.commit.author/committer.date` path would get me the commit date. I would hope that this would save somebody a little bit of time in the future. ## How has this been tested? I've built the docs locally and made sure the HTML is generated as expected. ## Screenshots ![2018-10-11 3](https://user-images.githubusercontent.com/16039329/46782728-add4d980-ccfd-11e8-88dd-1e48be629eb5.png)

mscheper · 2018-10-11T18:48:20Z

I just started with PyGithub, and found some examples, so obviously some work has been done—thanks, people!

But I don't see any examples for how to listen for events, e.g. pushevent and pullrequestevent. Could examples for those be added?

mscheper · 2018-10-15T18:54:18Z

Thanks, @LeviMatus!

## What does this change do? Adds a small demo implementation of how one might use webhooks to listen for new events in a given repository. ### Additions #### doc/examples/Webhook.rst Adds a new `.rst` file, `Webhook.rst`, which can be used for demonstrating the usage of Webhooks in PyGithub. The example that I've added shows how to continually listen for events using Pyramid in conjunction with PyGithub. ## Motivation This example is in the spirit of #874. [It was asked](#874 (comment)) that someone provide an example of how to listen to events from a repository. ## How has this been tested? I've built the docs locally and made sure the HTML is generated as expected. ## Screenshots ![webhook1](https://user-images.githubusercontent.com/16039329/46991191-40e58900-d0db-11e8-87e4-d5cf2cc18b0a.png) ![webhook2](https://user-images.githubusercontent.com/16039329/46991193-42af4c80-d0db-11e8-9b20-678f70e6baee.png)

In the spirit of PyGithub#874, add some examples for working with Branch objects. It doesn't add everything, but it's a start.

In the spirit of #874, add some examples for working with Branch objects. It doesn't add everything, but it's a start.

stale · 2018-12-14T19:35:37Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

stale · 2019-04-03T22:37:28Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

yks0000 · 2019-05-28T13:27:05Z

I am new to PyGithub SDK and trying to do below operations. However, having difficulty going through documents to know the usage.

get a file content from a specific branch

command line equivalent:

git checkout <<branch>> and then get file content

Issue:

I am able to get file content from master branch using this sdk but not from specific branch

repo tags and its details

command line equivalent:

git tag -v <<tag_id>>

Update that file

I see here the docs https://pygithub.readthedocs.io/en/latest/examples/Repository.html#update-a-file-in-the-repository

Update user details for commit

git config user.email "[email protected]"
git config user.name "cicd"
git commit --amend --reset-author --no-edit

Git pull that branch before commit as other automation might have committed some other file.
git commit in the branch

git pull --no-edit
git add $FILE_NAME
git commit -m "updating $FILE_NAME"
git pull --no-edit && git push origin

I am also trying to find the method/api of this sdk to do that, but if someone have it ready, please help with the same.

stale · 2019-07-27T14:28:19Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

mancuss · 2019-10-29T10:06:14Z

Hello, I'm a relatively new developer and this is helping a lot. Is any one planning to do examples for github app? Thanks!

estagumor · 2019-12-04T10:17:22Z

I am new to PyGithub SDK and trying to do below operations. However, having difficulty going through documents to know the usage.

get a file content from a specific branch

command line equivalent:

git checkout <<branch>> and then get file content

Issue:

I am able to get file content from master branch using this sdk but not from specific branch

repo tags and its details

command line equivalent:

git tag -v <<tag_id>>

Update that file

I see here the docs https://pygithub.readthedocs.io/en/latest/examples/Repository.html#update-a-file-in-the-repository

Update user details for commit
git config user.email "[email protected]"
git config user.name "cicd"
git commit --amend --reset-author --no-edit
Git pull that branch before commit as other automation might have committed some other file.

git commit in the branch
git pull --no-edit
git add $FILE_NAME
git commit -m "updating $FILE_NAME"
git pull --no-edit && git push origin
I am also trying to find the method/api of this sdk to do that, but if someone have it ready, please help with the same.

hi! I'm trying to get the content of an specific branch too. Did you get it? Thanks!

gfleetwood · 2020-05-03T06:58:56Z

@estagumor If you still need this answer the key is the ref parameter in the get_contents function. The default is "master". Here's an example getting the contents of the "0.6.X" branch of the scikit-learn repo.

from github import Github

g = Github("USERNAME", "PASSWORD")
repo = g.get_repo("scikit-learn/scikit-learn")
repo.get_contents("", ref = "0.6.X")

qbits-rwx · 2020-06-18T12:21:12Z

@sfdye I just started working with PyGithub and it works great. However even if i'am familiar with the git api, it would be great if you can provide a working example of how to set create / set branch protection rules.

I tried for example:
g.get_repo('SECRET/SECRET').get_branch('master').add_required_signatures()

sfdye · 2020-06-18T12:24:43Z

@qbits-rwx I think the method you need is:
https://pygithub.readthedocs.io/en/latest/github_objects/Branch.html#github.Branch.Branch.edit_protection

https://developer.github.com/v3/repos/branches/#update-branch-protection

qbits-rwx · 2020-06-18T14:15:11Z

Yes this did the trick. Unfortunately, require signed commits, is not implemented. Would be nice to have, as it is a policy we need to set on every branch.

sfdye · 2020-06-19T00:11:14Z

Feel free to send a FR or PR

xpdable · 2020-08-10T11:05:38Z

#1628 A full example to upload multipe files in one commit

shriaas2898 · 2020-08-22T11:09:02Z

Hey, I was going through Pull Requests examples, is there any way to get a pull request by its HTML? Or is there any function available to convert HTML URL to Github API query?

This PR add the follow code examples * Issue examples (get list, get specific issue, create issue) * Milestone examples (get list, get specific milestone, create milestone) Ref.: PyGithub#874

## What does this change do? Adds a small example of how to get at the date a commit took place. ### Changes #### doc/examples/Commit.rst Adds a block of code that demonstrates how to get at a commit's date. ## Motivation This example is in the spirit of PyGithub#874. When I began using PyGithub it was not readily apparent to me where the commit date was being abstracted to. Being unfamiliar with Git's API, it took some convincing for me to be satisfied that the `Commit.commit.author/committer.date` path would get me the commit date. I would hope that this would save somebody a little bit of time in the future. ## How has this been tested? I've built the docs locally and made sure the HTML is generated as expected. ## Screenshots ![2018-10-11 3](https://user-images.githubusercontent.com/16039329/46782728-add4d980-ccfd-11e8-88dd-1e48be629eb5.png)

## What does this change do? Adds a small demo implementation of how one might use webhooks to listen for new events in a given repository. ### Additions #### doc/examples/Webhook.rst Adds a new `.rst` file, `Webhook.rst`, which can be used for demonstrating the usage of Webhooks in PyGithub. The example that I've added shows how to continually listen for events using Pyramid in conjunction with PyGithub. ## Motivation This example is in the spirit of PyGithub#874. [It was asked](PyGithub#874 (comment)) that someone provide an example of how to listen to events from a repository. ## How has this been tested? I've built the docs locally and made sure the HTML is generated as expected. ## Screenshots ![webhook1](https://user-images.githubusercontent.com/16039329/46991191-40e58900-d0db-11e8-87e4-d5cf2cc18b0a.png) ![webhook2](https://user-images.githubusercontent.com/16039329/46991193-42af4c80-d0db-11e8-9b20-678f70e6baee.png)

In the spirit of PyGithub#874, add some examples for working with Branch objects. It doesn't add everything, but it's a start.

NicoWeio · 2021-03-11T14:22:23Z

Thanks a lot for these examples! What I'm missing is an example for exception handling. For instance, it wasn't immediately clear to me how to catch a github.GithubException.UnknownObjectException.

wsjohnso007 · 2021-10-26T14:20:29Z

Test show the test result

nitishagar · 2021-12-05T12:27:54Z

Yes this did the trick. Unfortunately, require signed commits, is not implemented. Would be nice to have, as it is a policy we need to set on every branch.

@qbits-rwx Following should help with "require signed commit" setting on a branch: https://pygithub.readthedocs.io/en/latest/github_objects/Branch.html#github.Branch.Branch.add_required_signatures

sfdye added the documentation label Aug 21, 2018

sfdye mentioned this issue Aug 21, 2018

More Examples #862

Closed

sfdye mentioned this issue Aug 21, 2018

Guide or documentation for . . . . . #456

Closed

sfdye mentioned this issue Aug 21, 2018

Please write better examples for documentation #321

Closed

sfdye mentioned this issue Aug 21, 2018

Establish basis for examples #762

Closed

allevin mentioned this issue Aug 21, 2018

Add Pull Request Examples #875

Merged

sfdye added the high priority label Aug 23, 2018

sfdye added the good first issue label Sep 5, 2018

sfdye added the Hacktoberfest label Oct 2, 2018

vishalsodani added a commit to vishalsodani/PyGithub that referenced this issue Oct 6, 2018

Add examples for Repository as per PyGithub#874

16b7459

sfdye added a commit that referenced this issue Oct 6, 2018

Add examples for Repository as per #874 (#917)

1916551

vishalsodani added a commit to vishalsodani/PyGithub that referenced this issue Oct 6, 2018

Add examples for search repositories (PyGithub#874)

3991a9e

mstuttgart mentioned this issue Oct 7, 2018

New use examples #920

Merged

vishalsodani added a commit to vishalsodani/PyGithub that referenced this issue Oct 8, 2018

Add examples for search repositories (PyGithub#874)

d11cd28

use repr to display objects

vishalsodani added a commit to vishalsodani/PyGithub that referenced this issue Oct 8, 2018

Add examples for search repositories (PyGithub#874)

a155462

use repr to display objects

sfdye added a commit that referenced this issue Oct 8, 2018

Add examples for searching repositories (#874) (#918)

8f4f40e

sfdye added a commit that referenced this issue Oct 8, 2018

New use examples (#920)

228e5e8

This PR add the follow code examples * Issue examples (get list, get specific issue, create issue) * Milestone examples (get list, get specific milestone, create milestone) Ref.: #874

LeviMatus mentioned this issue Oct 11, 2018

Example to show How to get Commit Date #927

Merged

PyGithub deleted a comment from Abdur-rahmaanJ Oct 12, 2018

LeviMatus mentioned this issue Oct 13, 2018

Example: Listen for New Events with PyGithub and Pyramid #930

Merged

sfdye mentioned this issue Oct 16, 2018

Add a trailing slash to URL when updating or deleting a file (tests fixed) #931

Merged

s-t-e-v-e-n-k added a commit to s-t-e-v-e-n-k/PyGithub that referenced this issue Oct 18, 2018

Add some examples for Branch

22a7ba3

In the spirit of PyGithub#874, add some examples for working with Branch objects. It doesn't add everything, but it's a start.

s-t-e-v-e-n-k mentioned this issue Oct 18, 2018

Add some examples for Branch #936

Merged

sfdye added a commit that referenced this issue Oct 18, 2018

Add some examples for Branch (#936)

2b2ecfa

In the spirit of #874, add some examples for working with Branch objects. It doesn't add everything, but it's a start.

stale bot added the stale label Apr 3, 2019

sfdye removed the stale label Apr 4, 2019

stale bot added the stale label Jul 27, 2019

stale bot closed this Aug 3, 2019

sfdye reopened this Sep 13, 2019

stale bot removed the stale label Sep 13, 2019

sfdye removed the Hacktoberfest label Sep 27, 2019

sfdye mentioned this issue Jun 18, 2020

Add deployments documentation #1564

Closed

augustoolucas mentioned this issue Jul 14, 2020

Is it possible to get the hyperlinks of issues' body? #1603

Closed

candrikos added a commit to candrikos/PyGithub that referenced this issue Sep 25, 2020

Add examples for Repository as per PyGithub#874 (PyGithub#917)

38f7128

candrikos added a commit to candrikos/PyGithub that referenced this issue Sep 25, 2020

Add examples for searching repositories (PyGithub#874) (PyGithub#918)

6691059

candrikos added a commit to candrikos/PyGithub that referenced this issue Sep 25, 2020

Add some examples for Branch (PyGithub#936)

cef7107

In the spirit of PyGithub#874, add some examples for working with Branch objects. It doesn't add everything, but it's a start.

Nov	JAN	Jun
	06
2020	2022	2023

PyGithub / PyGithub Public

PyGithub example usage #874

PyGithub example usage #874

sfdye commented Aug 21, 2018 •

edited

Abdur-rahmaanJ commented Aug 21, 2018

mscheper commented Oct 11, 2018 •

edited

mscheper commented Oct 15, 2018

stale bot commented Dec 14, 2018

stale bot commented Apr 3, 2019

yks0000 commented May 28, 2019 •

edited

stale bot commented Jul 27, 2019

mancuss commented Oct 29, 2019

estagumor commented Dec 4, 2019

gfleetwood commented May 3, 2020

qbits-rwx commented Jun 18, 2020

sfdye commented Jun 18, 2020

qbits-rwx commented Jun 18, 2020

sfdye commented Jun 19, 2020

xpdable commented Aug 10, 2020

shriaas2898 commented Aug 22, 2020 •

edited

NicoWeio commented Mar 11, 2021

wsjohnso007 commented Oct 26, 2021

nitishagar commented Dec 5, 2021

PyGithub / PyGithub Public

PyGithub example usage #874

PyGithub example usage #874

Comments

sfdye commented Aug 21, 2018 • edited

Abdur-rahmaanJ commented Aug 21, 2018

mscheper commented Oct 11, 2018 • edited

mscheper commented Oct 15, 2018

stale bot commented Dec 14, 2018

stale bot commented Apr 3, 2019

yks0000 commented May 28, 2019 • edited

stale bot commented Jul 27, 2019

mancuss commented Oct 29, 2019

estagumor commented Dec 4, 2019

gfleetwood commented May 3, 2020

qbits-rwx commented Jun 18, 2020

sfdye commented Jun 18, 2020

qbits-rwx commented Jun 18, 2020

sfdye commented Jun 19, 2020

xpdable commented Aug 10, 2020

shriaas2898 commented Aug 22, 2020 • edited

NicoWeio commented Mar 11, 2021

wsjohnso007 commented Oct 26, 2021

nitishagar commented Dec 5, 2021

sfdye commented Aug 21, 2018 •

edited

mscheper commented Oct 11, 2018 •

edited

yks0000 commented May 28, 2019 •

edited

shriaas2898 commented Aug 22, 2020 •

edited