github extractor package

概述

GitHub提取器軟件包是一個python庫，旨在促進從GitHub提取數據。

該軟件包提供了有關存儲庫的信息，包括所使用的語言，發行版，主題，工作流以及更多的錯誤處理和配置支持。

特徵

• 列出了GitHub用戶的組織。
• 列出GitHub用戶的存儲庫。
• 列出GitHub指定組織的存儲庫。
• 使用GitHub API令牌支持身份驗證。
• 根據給定模式過濾組織和存儲庫。
• 分頁處理API請求。

安裝

您可以通過PIP安裝GitHub提取器：

pip install wolfsoftware.github-extractor

用法

獲取令牌信息

您將獲得與給定令牌有關的基本信息。

此GitHub令牌驗證器還有一個特定的命令行工具。

 from wolfsoftware . github_extractor import get_token_information

config = {
    "token" : "your_github_token" ,
}

參數

姓名	必需的	目的
令牌	是的	GitHub API的身份驗證。
暫停	不	與GitHub API交談時使用的超時（默認為10秒）。
sl	不	我們是否應該將結果歸還為sl。 （名稱列表，什麼都沒有）。

獲取用戶信息

您獲得了與已驗證的用戶（令牌的所有者）有關的基本信息。該信息將受到令牌範圍的限制。

 from wolfsoftware . github_extractor import get_authenticated_user

config = {
    "token" : "your_github_token" ,
}

參數

姓名	必需的	目的
令牌	是的	GitHub API的身份驗證。
暫停	不	與GitHub API交談時使用的超時（默認為10秒）。
sl	不	我們是否應該將結果歸還為sl。 （名稱列表，什麼都沒有）。

上市組織

您可以列出您是使用英國或美國英語拼寫成員的組織。

 from wolfsoftware . github_extractor import list_organisations , list_organizations

config = {
    "token" : "your_github_token" ,
    "ignore_orgs" : [ "Test*" ]
}

# Using British English spelling
organisations = list_organisations ( config )

# Using American English spelling
organisations_us = list_organizations ( config )

參數

姓名	必需的	目的
令牌	是的	GitHub API的身份驗證。
暫停	不	與GitHub API交談時使用的超時（默認為10秒）。
sl	不	我們是否應該將結果歸還為sl。 （名稱列表，什麼都沒有）。

過濾參數

姓名	必需的	目的
包括_orgs	不	結果中包含的組織名稱列表。
ignore_orgs	不	從結果中排除的組織名稱列表。
get_members	不	我們應該在結果中加入組織成員嗎？

清單用戶存儲庫

您可以列出具有可選過濾器的用戶的存儲庫：

 from wolfsoftware . github_extractor import list_user_repositories

config = {
    "token" : "your_github_token" ,
    "ignore_repos" : [ "Test*" ],
    "include_repos" : [ "Project*" ]
}

repositories = list_user_repositories ( config )

參數

姓名	必需的	目的
令牌	不	GitHub API的身份驗證。
暫停	不	與GitHub API交談時使用的超時（默認為10秒）。
sl	不	我們是否應該將結果歸還為sl。 （名稱列表，什麼都沒有）。
使用者名稱	不	github用戶名列出了存儲庫。 （將使用身份驗證的用戶是不提供的）。

其他數據參數

姓名	必需的	目的
get_branches	不	在每個存儲庫中添加有關所有分支的詳細信息。
get_contributor	不	在每個存儲庫中添加有關所有貢獻者的詳細信息。
get_languages	不	添加每個存儲庫確定的語言列表。
get_releases	不	將有關所有版本的詳細信息添加到每個存儲庫中。
get_tags	不	將有關所有標籤的詳細信息添加到每個存儲庫中。
get_topics	不	將定義主題的列表添加到每個存儲庫中。
get_workflows	不	將有關所有工作流程的詳細信息添加到每個存儲庫中。

過濾參數

姓名	必需的	目的
include_names	不	要在結果中包含的存儲庫列表。
ignore_names	不	存儲庫名單列表，要從結果中排除。
包括_repos	不	將包含在結果中的組織名稱/存儲庫列表。
ignore_repos	不	組織名稱/存儲庫名稱列表，要從結果中排除。
Skip_private	不	不包括私人存儲庫，這僅適用於身份驗證的用戶。

忽略並包含名稱使用存儲庫的全名，即組織名稱 /存儲庫名稱，例如githubtoolbox / github-extractor-package

按組織上市存儲庫

您可以列出具有可選過濾器的特定組織的存儲庫：

 from wolfsoftware . github_extractor import list_repositories_by_org

config = {
    "token" : "your_github_token" ,
    "org_name" : "your_organization" ,
    "ignore_repos" : [ "Test*" ],
    "include_repos" : [ "Project*" ]
}

repositories = list_repositories_by_org ( config )

參數

姓名	必需的	目的
令牌	不	GitHub API的身份驗證。
暫停	不	與GitHub API交談時使用的超時（默認為10秒）。
sl	不	我們是否應該將結果歸還為sl。 （名稱列表，什麼都沒有）。
org_name	不	GitHub組織列出存儲庫。

其他數據參數

姓名	必需的	目的
get_branches	不	在每個存儲庫中添加有關所有分支的詳細信息。
get_contributor	不	在每個存儲庫中添加有關所有貢獻者的詳細信息。
get_languages	不	添加每個存儲庫確定的語言列表。
get_releases	不	將有關所有版本的詳細信息添加到每個存儲庫中。
get_tags	不	將有關所有標籤的詳細信息添加到每個存儲庫中。
get_topics	不	將定義主題的列表添加到每個存儲庫中。
get_workflows	不	將有關所有工作流程的詳細信息添加到每個存儲庫中。

過濾參數

姓名	必需的	目的
include_names	不	要在結果中包含的存儲庫列表。
ignore_names	不	存儲庫名單列表，要從結果中排除。
包括_repos	不	將包含在結果中的組織名稱/存儲庫列表。
ignore_repos	不	組織名稱/存儲庫名稱列表，要從結果中排除。
Skip_private	不	不包括私人存儲庫，這僅適用於身份驗證的用戶。

忽略並包含名稱使用存儲庫的全名，即組織名稱 /存儲庫名稱，例如githubtoolbox / github-extractor-package

列出所有組織存儲庫

您可以列出您成員的所有組織的所有存儲庫。

 from wolfsoftware . github_extractor import list_all_org_repositories

config = {
    "token" : "your_github_token" ,
    "ignore_repos" : [ "Test*" ],
    "include_repos" : [ "Project*" ]
}

repositories = list_all_org_repositories ( config )

參數

姓名	必需的	目的
令牌	是的	GitHub API的身份驗證。
暫停	不	與GitHub API交談時使用的超時（默認為10秒）。
sl	不	我們是否應該將結果歸還為sl。 （名稱列表，什麼都沒有）。

其他數據參數

姓名	必需的	目的
get_branches	不	在每個存儲庫中添加有關所有分支的詳細信息。
get_contributor	不	在每個存儲庫中添加有關所有貢獻者的詳細信息。
get_languages	不	添加每個存儲庫確定的語言列表。
get_releases	不	將有關所有版本的詳細信息添加到每個存儲庫中。
get_tags	不	將有關所有標籤的詳細信息添加到每個存儲庫中。
get_topics	不	將定義主題的列表添加到每個存儲庫中。
get_workflows	不	將有關所有工作流程的詳細信息添加到每個存儲庫中。

過濾參數

姓名	必需的	目的
include_names	不	要在結果中包含的存儲庫列表。
ignore_names	不	存儲庫名單列表，要從結果中排除。
包括_repos	不	將包含在結果中的組織名稱/存儲庫列表。
ignore_repos	不	組織名稱/存儲庫名稱列表，要從結果中排除。
Skip_private	不	不包括私人存儲庫，這僅適用於身份驗證的用戶。

忽略並包含名稱使用存儲庫的全名，即組織名稱 /存儲庫名稱，例如githubtoolbox / github-extractor-package

列出所有可見的存儲庫

您可以列出您可以訪問的存儲庫。

 from wolfsoftware . github_extractor import list_all_visible_repositories

config = {
    "token" : "your_github_token" ,
    "ignore_repos" : [ "Test*" ],
    "include_repos" : [ "Project*" ]
}

repositories = list_all_visible_repositories ( config )

參數

姓名	必需的	目的
令牌	是的	GitHub API的身份驗證。
暫停	不	與GitHub API交談時使用的超時（默認為10秒）。
sl	不	我們是否應該將結果歸還為sl。 （名稱列表，什麼都沒有）。

其他數據參數

姓名	必需的	目的
get_branches	不	在每個存儲庫中添加有關所有分支的詳細信息。
get_contributor	不	在每個存儲庫中添加有關所有貢獻者的詳細信息。
get_languages	不	添加每個存儲庫確定的語言列表。
get_releases	不	將有關所有版本的詳細信息添加到每個存儲庫中。
get_tags	不	將有關所有標籤的詳細信息添加到每個存儲庫中。
get_topics	不	將定義主題的列表添加到每個存儲庫中。
get_workflows	不	將有關所有工作流程的詳細信息添加到每個存儲庫中。

過濾參數

姓名	必需的	目的
include_names	不	要在結果中包含的存儲庫列表。
ignore_names	不	存儲庫名單列表，要從結果中排除。
包括_repos	不	將包含在結果中的組織名稱/存儲庫列表。
ignore_repos	不	組織名稱/存儲庫名稱列表，要從結果中排除。
Skip_private	不	不包括私人存儲庫，這僅適用於身份驗證的用戶。

忽略並包含名稱使用存儲庫的全名，即組織名稱 /存儲庫名稱，例如githubtoolbox / github-extractor-package

例外

使用以下自定義例外：

姓名	目的
AuthenticationError	當身份驗證失敗時會提出。這是由無效的令牌引起的。
失踪	當組織名稱丟失時提出。
失踪	當缺少github api令牌但需要時，提出。
NOTFOUNDERROR	當找不到請求資源時提出。這是由於令牌的不正確範圍引起的。
RatelimitexceededError	當超過GitHub API速率限制時升高。
RequestError	為一般請求錯誤而提出。
requestTimeouterror	提出要求時提出。