github extractor package

概要

GitHub抽出装置パッケージは、GitHubからのデータの抽出を容易にするために設計されたPythonライブラリです。

このパッケージは、使用された言語、リリース、貢献者、トピック、ワークフローなど、堅牢なエラー処理と構成サポートなど、リポジトリに関する情報を取得する機能を提供します。

特徴

• 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秒）。
ナメクジ	いいえ	結果をナメクジとして返す必要があります。 （名前のリスト、その他何もありません）。

ユーザー情報の取得

認証されたユーザー（トークンの所有者）に関連する基本情報を取得します。情報は、トークンの範囲によって制限されます。

 from wolfsoftware . github_extractor import get_authenticated_user

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

パラメーター

名前	必須	目的
トークン	はい	Github APIの認証。
タイムアウト	いいえ	GitHub APIと話すときに使用するタイムアウト（デフォルトは10秒）。
ナメクジ	いいえ	結果をナメクジとして返す必要があります。 （名前のリスト、その他何もありません）。

リスティング組織

英国またはアメリカの英語のスペルを使用するメンバーである組織をリストできます。

 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秒）。
ナメクジ	いいえ	結果をナメクジとして返す必要があります。 （名前のリスト、その他何もありません）。

フィルタリングパラメーター

名前	必須	目的
include_orgs	いいえ	結果に含める組織名のリスト。
Ingrore_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秒）。
ナメクジ	いいえ	結果をナメクジとして返す必要があります。 （名前のリスト、その他何もありません）。
ユーザー名	いいえ	githubユーザー名は、リポジトリをリストします。 （認証されたユーザーが使用されますが、これは提供されていません）。

追加のデータパラメーター

名前	必須	目的
get_branches	いいえ	すべてのブランチの詳細を各リポジトリに追加します。
get_contributors	いいえ	各リポジトリにすべての貢献者の詳細を追加します。
get_languages	いいえ	各リポジトリの識別言語のリストを追加します。
get_releases	いいえ	すべてのリリースの詳細を各リポジトリに追加します。
get_tags	いいえ	すべてのタグの詳細を各リポジトリに追加します。
get_topics	いいえ	定義されたトピックのリストを各リポジトリに追加します。
get_workflows	いいえ	すべてのワークフローの詳細を各リポジトリに追加します。

フィルタリングパラメーター

名前	必須	目的
include_names	いいえ	結果に含めるリポジトリ名のリスト。
Ingrore_names	いいえ	結果から除外するリポジトリ名のリスト。
include_repos	いいえ	結果に含める組織名/リポジトリ名のリスト。
INGRORE_REPOS	いいえ	結果から除外する組織名/リポジトリ名のリスト。
SKIP_PRIVATE	いいえ	プライベートリポジトリを含めないでください。これは、認証されたユーザー専用です。

無視して名前を含めるリポジトリのフルネームを使用します。これは組織名 /リポジトリ名です。

組織別のリポジトリのリスト

オプションのフィルターを備えた特定の組織のリポジトリをリストできます。

 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秒）。
ナメクジ	いいえ	結果をナメクジとして返す必要があります。 （名前のリスト、その他何もありません）。
org_name	いいえ	Github組織は、リポジトリをリストします。

追加のデータパラメーター

名前	必須	目的
get_branches	いいえ	すべてのブランチの詳細を各リポジトリに追加します。
get_contributors	いいえ	各リポジトリにすべての貢献者の詳細を追加します。
get_languages	いいえ	各リポジトリの識別言語のリストを追加します。
get_releases	いいえ	すべてのリリースの詳細を各リポジトリに追加します。
get_tags	いいえ	すべてのタグの詳細を各リポジトリに追加します。
get_topics	いいえ	定義されたトピックのリストを各リポジトリに追加します。
get_workflows	いいえ	すべてのワークフローの詳細を各リポジトリに追加します。

フィルタリングパラメーター

名前	必須	目的
include_names	いいえ	結果に含めるリポジトリ名のリスト。
Ingrore_names	いいえ	結果から除外するリポジトリ名のリスト。
include_repos	いいえ	結果に含める組織名/リポジトリ名のリスト。
INGRORE_REPOS	いいえ	結果から除外する組織名/リポジトリ名のリスト。
SKIP_PRIVATE	いいえ	プライベートリポジトリを含めないでください。これは、認証されたユーザー専用です。

無視して名前を含めるリポジトリのフルネームを使用します。これは組織名 /リポジトリ名です。

すべての組織リポジトリをリストします

メンバーであるすべての組織のすべてのリポジトリをリストできます。

 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秒）。
ナメクジ	いいえ	結果をナメクジとして返す必要があります。 （名前のリスト、その他何もありません）。

追加のデータパラメーター

名前	必須	目的
get_branches	いいえ	すべてのブランチの詳細を各リポジトリに追加します。
get_contributors	いいえ	各リポジトリにすべての貢献者の詳細を追加します。
get_languages	いいえ	各リポジトリの識別言語のリストを追加します。
get_releases	いいえ	すべてのリリースの詳細を各リポジトリに追加します。
get_tags	いいえ	すべてのタグの詳細を各リポジトリに追加します。
get_topics	いいえ	定義されたトピックのリストを各リポジトリに追加します。
get_workflows	いいえ	すべてのワークフローの詳細を各リポジトリに追加します。

フィルタリングパラメーター

名前	必須	目的
include_names	いいえ	結果に含めるリポジトリ名のリスト。
Ingrore_names	いいえ	結果から除外するリポジトリ名のリスト。
include_repos	いいえ	結果に含める組織名/リポジトリ名のリスト。
INGRORE_REPOS	いいえ	結果から除外する組織名/リポジトリ名のリスト。
SKIP_PRIVATE	いいえ	プライベートリポジトリを含めないでください。これは、認証されたユーザー専用です。

無視して名前を含めるリポジトリのフルネームを使用します。これは組織名 /リポジトリ名です。

目に見えるすべてのリポジトリをリストします

アクセスできるリポジトリをリストできます。

 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秒）。
ナメクジ	いいえ	結果をナメクジとして返す必要があります。 （名前のリスト、その他何もありません）。

追加のデータパラメーター

名前	必須	目的
get_branches	いいえ	すべてのブランチの詳細を各リポジトリに追加します。
get_contributors	いいえ	各リポジトリにすべての貢献者の詳細を追加します。
get_languages	いいえ	各リポジトリの識別言語のリストを追加します。
get_releases	いいえ	すべてのリリースの詳細を各リポジトリに追加します。
get_tags	いいえ	すべてのタグの詳細を各リポジトリに追加します。
get_topics	いいえ	定義されたトピックのリストを各リポジトリに追加します。
get_workflows	いいえ	すべてのワークフローの詳細を各リポジトリに追加します。

フィルタリングパラメーター

名前	必須	目的
include_names	いいえ	結果に含めるリポジトリ名のリスト。
Ingrore_names	いいえ	結果から除外するリポジトリ名のリスト。
include_repos	いいえ	結果に含める組織名/リポジトリ名のリスト。
INGRORE_REPOS	いいえ	結果から除外する組織名/リポジトリ名のリスト。
SKIP_PRIVATE	いいえ	プライベートリポジトリを含めないでください。これは、認証されたユーザー専用です。

無視して名前を含めるリポジトリのフルネームを使用します。これは組織名 /リポジトリ名です。

例外

次のカスタム例外が使用されます。

名前	目的
AuthenticationError	認証が失敗したときに発生します。これは、無効なトークンによって引き起こされます。
MissingorgnameError	組織名がありません。
MissingTokenError	Github APIトークンが欠落しているときに掲載されますが、必要です。
notfounderror	要求されたリソースが見つからないときに掲載されます。これは、トークンの誤った範囲によって引き起こされます。
ratelimitexhechedederror	GitHub APIレートの制限を超えると上げられます。
RequestError	一般的な要求エラーのために提起されました。
RequestTimeOuterror	リクエストがタイムアウトするときに提起されました。