PyGithub/PyGithub

PyGithub example usage

Open

#874 opened on Aug 21, 2018

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

Repository metrics

Stars
 (6,482 stars)
PR merge metrics
 (Avg merge 5d 20h) (21 merged PRs in 30d)

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

Research direction
Choose an example from the GitHub API that is not yet in the doc/examples directory and write a Python script demonstrating its usage. Follow the existing example structure and create a pull request.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90