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	提出要求时提出。