PyGithub/PyGithub

PyGithub example usage

Open

#874 opened on Aug 21, 2018

View on GitHub
 (24 comments) (18 reactions) (0 assignees)Python (6,482 stars) (1,715 forks)batch import
documentationgood first issuehigh priority

Description

Motivation: #862 #456 #321 #584 #762

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.

Contributor guide

Tech stack
pythonrest api
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic Python knowledgefamiliarity with GitHub API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Review the existing example scripts in doc/examples/ to understand the format and structure. Choose a GitHub API endpoint not yet covered, such as repository creation or issue management. Write a new Python script that demonstrates the usage with clear comments and a docstring. Test the script locally to ensure it works, then submit a pull request adding the file to doc/examples/.