PyGithub/PyGithub

PyGithub example usage

Open

#874 建立於 2018年8月21日

在 GitHub 查看
 (24 留言) (18 反應) (0 負責人)Python (6,482 star) (1,715 fork)batch import
documentationgood first issuehigh priority

描述

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.

貢獻者指南

技術棧
pythonrest api
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic Python knowledgefamiliarity with GitHub API
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85
研究方向
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/.
PyGithub example usage · PyGithub/PyGithub#874 | Good First Issue