PyGithub example usage
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 7.8k
- Forks
- 1.9k
- Avg merge
- 17m
- Merged PRs (30d)
- 2
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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the existing skeleton in doc/examples and review the published examples at examples.html to understand the current coverage. Choose a missing PyGithub usage recipe, add a working example in doc/examples, and consider the work complete when the example is documented and usable by someone new to the library.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Needs clarification
- Newbie friendliness
- 48/100