Skip to main content

​
prefect_github.user

This is a module containing: GitHub query_user* tasks

​
Functions

​
query_user 

query_user(login: str, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
The query root of GitHub’s GraphQL interface. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_gist 

query_user_gist(login: str, name: str, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Find gist by repo name. Args:
  • login: The user’s login.
  • name: The gist name to find.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_gists 

query_user_gists(login: str, github_credentials: GitHubCredentials, privacy: graphql_schema.GistPrivacy = None, order_by: graphql_schema.GistOrder = None, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of the Gists the user has created. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • privacy: Filters Gists according to privacy.
  • order_by: Ordering options for gists returned from the connection.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_issues 

query_user_issues(login: str, labels: Iterable[str], states: Iterable[graphql_schema.IssueState], github_credentials: GitHubCredentials, order_by: graphql_schema.IssueOrder = None, filter_by: graphql_schema.IssueFilters = None, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of issues associated with this user. Args:
  • login: The user’s login.
  • labels: A list of label names to filter the pull requests by.
  • states: A list of states to filter the issues by.
  • github_credentials: Credentials to use for authentication with GitHub.
  • order_by: Ordering options for issues returned from the connection.
  • filter_by: Filtering options for issues returned from the connection.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_status 

query_user_status(login: str, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
The user’s description of what they’re currently doing. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_project 

query_user_project(login: str, number: int, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Find project by number. Args:
  • login: The user’s login.
  • number: The project number to find.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_packages 

query_user_packages(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, names: Optional[Iterable[str]] = None, repository_id: Optional[str] = None, package_type: graphql_schema.PackageType = None, order_by: graphql_schema.PackageOrder = {'field': 'CREATED_AT', 'direction': 'DESC'}, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of packages under the owner. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • names: Find packages by their names.
  • repository_id: Find packages in a repository by ID.
  • package_type: Filter registry package by type.
  • order_by: Ordering of the returned packages.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_projects 

query_user_projects(login: str, states: Iterable[graphql_schema.ProjectState], github_credentials: GitHubCredentials, order_by: graphql_schema.ProjectOrder = None, search: Optional[str] = None, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of projects under the owner. Args:
  • login: The user’s login.
  • states: A list of states to filter the projects by.
  • github_credentials: Credentials to use for authentication with GitHub.
  • order_by: Ordering options for projects returned from the connection.
  • search: Query to search projects by, currently only searching by name.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_sponsors 

query_user_sponsors(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, tier_id: Optional[str] = None, order_by: graphql_schema.SponsorOrder = {'field': 'RELEVANCE', 'direction': 'DESC'}, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
List of sponsors for this user or organization. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • tier_id: If given, will filter for sponsors at the given tier. Will only return sponsors whose tier the viewer is permitted to see.
  • order_by: Ordering options for sponsors returned from the connection.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_watching 

query_user_watching(login: str, github_credentials: GitHubCredentials, privacy: graphql_schema.RepositoryPrivacy = None, order_by: graphql_schema.RepositoryOrder = None, affiliations: Iterable[graphql_schema.RepositoryAffiliation] = None, owner_affiliations: Iterable[graphql_schema.RepositoryAffiliation] = ('OWNER', 'COLLABORATOR'), is_locked: Optional[bool] = None, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of repositories the given user is watching. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • privacy: If non-null, filters repositories according to privacy.
  • order_by: Ordering options for repositories returned from the connection.
  • affiliations: Affiliation options for repositories returned from the connection. If none specified, the results will include repositories for which the current viewer is an owner or collaborator, or member.
  • owner_affiliations: Array of owner’s affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the organization or user being viewed owns.
  • is_locked: If non-null, filters repositories according to whether they have been locked.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_project_v2 

query_user_project_v2(login: str, number: int, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Find a project by number. Args:
  • login: The user’s login.
  • number: The project number.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_followers 

query_user_followers(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of users the given user is followed by. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_following 

query_user_following(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of users the given user is following. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_projects_v2 

query_user_projects_v2(login: str, github_credentials: GitHubCredentials, query: Optional[str] = None, order_by: graphql_schema.ProjectV2Order = {'field': 'NUMBER', 'direction': 'DESC'}, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of projects under the owner. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • query: A project to search for under the the owner.
  • order_by: How to order the returned projects.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_repository 

query_user_repository(login: str, name: str, github_credentials: GitHubCredentials, follow_renames: bool = True, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Find Repository. Args:
  • login: The user’s login.
  • name: Name of Repository to find.
  • github_credentials: Credentials to use for authentication with GitHub.
  • follow_renames: Follow repository renames. If disabled, a repository referenced by its old name will return an error.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_sponsoring 

query_user_sponsoring(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, order_by: graphql_schema.SponsorOrder = {'field': 'RELEVANCE', 'direction': 'DESC'}, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
List of users and organizations this entity is sponsoring. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • order_by: Ordering options for the users and organizations returned from the connection.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_public_keys 

query_user_public_keys(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of public keys associated with this user. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_project_next 

query_user_project_next(login: str, number: int, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Find a project by project (beta) number. Args:
  • login: The user’s login.
  • number: The project (beta) number.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_pinned_items 

query_user_pinned_items(login: str, types: Iterable[graphql_schema.PinnableItemType], github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of repositories and gists this profile owner has pinned to their profile. Args:
  • login: The user’s login.
  • types: Filter the types of pinned items that are returned.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_projects_next 

query_user_projects_next(login: str, github_credentials: GitHubCredentials, query: Optional[str] = None, sort_by: graphql_schema.ProjectNextOrderField = 'TITLE', after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of projects (beta) under the owner. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • query: A project (beta) to search for under the the owner.
  • sort_by: How to order the returned projects (beta).
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_repositories 

query_user_repositories(login: str, github_credentials: GitHubCredentials, privacy: graphql_schema.RepositoryPrivacy = None, order_by: graphql_schema.RepositoryOrder = None, affiliations: Iterable[graphql_schema.RepositoryAffiliation] = None, owner_affiliations: Iterable[graphql_schema.RepositoryAffiliation] = ('OWNER', 'COLLABORATOR'), is_locked: Optional[bool] = None, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, is_fork: Optional[bool] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of repositories that the user owns. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • privacy: If non-null, filters repositories according to privacy.
  • order_by: Ordering options for repositories returned from the connection.
  • affiliations: Array of viewer’s affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the current viewer owns.
  • owner_affiliations: Array of owner’s affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the organization or user being viewed owns.
  • is_locked: If non-null, filters repositories according to whether they have been locked.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • is_fork: If non-null, filters repositories according to whether they are forks of another repository.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_item_showcase 

query_user_item_showcase(login: str, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Showcases a selection of repositories and gists that the profile owner has either curated or that have been selected automatically based on popularity. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_gist_comments 

query_user_gist_comments(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of gist comments made by this user. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_organization 

query_user_organization(login: str, organization_login: str, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Find an organization by its login that the user belongs to. Args:
  • login: The user’s login.
  • organization_login: The login of the organization to find.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_pull_requests 

query_user_pull_requests(login: str, states: Iterable[graphql_schema.PullRequestState], labels: Iterable[str], github_credentials: GitHubCredentials, head_ref_name: Optional[str] = None, base_ref_name: Optional[str] = None, order_by: graphql_schema.IssueOrder = None, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of pull requests associated with this user. Args:
  • login: The user’s login.
  • states: A list of states to filter the pull requests by.
  • labels: A list of label names to filter the pull requests by.
  • github_credentials: Credentials to use for authentication with GitHub.
  • head_ref_name: The head ref name to filter the pull requests by.
  • base_ref_name: The base ref name to filter the pull requests by.
  • order_by: Ordering options for pull requests returned from the connection.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_saved_replies 

query_user_saved_replies(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, order_by: graphql_schema.SavedReplyOrder = {'field': 'UPDATED_AT', 'direction': 'DESC'}, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Replies this user has saved. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • order_by: The field to order saved replies by.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_pinnable_items 

query_user_pinnable_items(login: str, types: Iterable[graphql_schema.PinnableItemType], github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of repositories and gists this profile owner can pin to their profile. Args:
  • login: The user’s login.
  • types: Filter the types of pinnable items that are returned.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_issue_comments 

query_user_issue_comments(login: str, github_credentials: GitHubCredentials, order_by: graphql_schema.IssueCommentOrder = None, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of issue comments made by this user. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • order_by: Ordering options for issue comments returned from the connection.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_organizations 

query_user_organizations(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of organizations the user belongs to. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_recent_projects 

query_user_recent_projects(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Recent projects that this user has modified in the context of the owner. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_commit_comments 

query_user_commit_comments(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of commit comments made by this user. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_sponsors_listing 

query_user_sponsors_listing(login: str, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
The GitHub Sponsors listing for this user or organization. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_top_repositories 

query_user_top_repositories(login: str, order_by: graphql_schema.RepositoryOrder, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, since: Optional[datetime] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created. Args:
  • login: The user’s login.
  • order_by: Ordering options for repositories returned from the connection.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • since: How far back in time to fetch contributed repositories.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_sponsors_activities 

query_user_sponsors_activities(login: str, actions: Iterable[graphql_schema.SponsorsActivityAction], github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, period: graphql_schema.SponsorsActivityPeriod = 'MONTH', order_by: graphql_schema.SponsorsActivityOrder = {'field': 'TIMESTAMP', 'direction': 'DESC'}, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Events involving this sponsorable, such as new sponsorships. Args:
  • login: The user’s login.
  • actions: Filter activities to only the specified actions.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • period: Filter activities returned to only those that occurred in the most recent specified time period. Set to ALL to avoid filtering by when the activity occurred.
  • order_by: Ordering options for activity returned from the connection.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_interaction_ability 

query_user_interaction_ability(login: str, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
The interaction ability settings for this user. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_starred_repositories 

query_user_starred_repositories(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, owned_by_viewer: Optional[bool] = None, order_by: graphql_schema.StarOrder = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Repositories the user has starred. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • owned_by_viewer: Filters starred repositories to only return repositories owned by the viewer.
  • order_by: Order for connection.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_repository_discussions 

query_user_repository_discussions(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, order_by: graphql_schema.DiscussionOrder = {'field': 'CREATED_AT', 'direction': 'DESC'}, repository_id: Optional[str] = None, answered: Optional[bool] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Discussions this user has started. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • order_by: Ordering options for discussions returned from the connection.
  • repository_id: Filter discussions to only those in a specific repository.
  • answered: Filter discussions to only those that have been answered or not. Defaults to including both answered and unanswered discussions.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_sponsorships_as_sponsor 

query_user_sponsorships_as_sponsor(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, order_by: graphql_schema.SponsorshipOrder = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
This object’s sponsorships as the sponsor. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • order_by: Ordering options for sponsorships returned from this connection. If left blank, the sponsorships will be ordered based on relevancy to the viewer.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_sponsorship_newsletters 

query_user_sponsorship_newsletters(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, order_by: graphql_schema.SponsorshipNewsletterOrder = {'field': 'CREATED_AT', 'direction': 'DESC'}, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
List of sponsorship updates sent from this sponsorable to sponsors. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • order_by: Ordering options for sponsorship updates returned from the connection.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_contributions_collection 

query_user_contributions_collection(login: str, github_credentials: GitHubCredentials, organization_id: Optional[str] = None, from_: Optional[datetime] = None, to: Optional[datetime] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
The collection of contributions this user has made to different repositories. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • organization_id: The ID of the organization used to filter contributions.
  • from_: Only contributions made at this time or later will be counted. If omitted, defaults to a year ago.
  • to: Only contributions made before and up to (including) this time will be counted. If omitted, defaults to the current time or one year from the provided from argument.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_sponsorships_as_maintainer 

query_user_sponsorships_as_maintainer(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, include_private: bool = False, order_by: graphql_schema.SponsorshipOrder = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
This object’s sponsorships as the maintainer. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • include_private: Whether or not to include private sponsorships in the result set.
  • order_by: Ordering options for sponsorships returned from this connection. If left blank, the sponsorships will be ordered based on relevancy to the viewer.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_repositories_contributed_to 

query_user_repositories_contributed_to(login: str, github_credentials: GitHubCredentials, privacy: graphql_schema.RepositoryPrivacy = None, order_by: graphql_schema.RepositoryOrder = None, is_locked: Optional[bool] = None, include_user_repositories: Optional[bool] = None, contribution_types: Iterable[graphql_schema.RepositoryContributionType] = None, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
A list of repositories that the user recently contributed to. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • privacy: If non-null, filters repositories according to privacy.
  • order_by: Ordering options for repositories returned from the connection.
  • is_locked: If non-null, filters repositories according to whether they have been locked.
  • include_user_repositories: If true, include user repositories.
  • contribution_types: If non-null, include only the specified types of contributions. The GitHub.com UI uses [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY].
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_repository_discussion_comments 

query_user_repository_discussion_comments(login: str, github_credentials: GitHubCredentials, after: Optional[str] = None, before: Optional[str] = None, first: Optional[int] = None, last: Optional[int] = None, repository_id: Optional[str] = None, only_answers: bool = False, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
Discussion comments this user has authored. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • after: Returns the elements in the list that come after the specified cursor.
  • before: Returns the elements in the list that come before the specified cursor.
  • first: Returns the first n elements from the list.
  • last: Returns the last n elements from the list.
  • repository_id: Filter discussion comments to only those in a specific repository.
  • only_answers: Filter discussion comments to only those that were marked as the answer.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_sponsorship_for_viewer_as_sponsor 

query_user_sponsorship_for_viewer_as_sponsor(login: str, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
The sponsorship from the viewer to this user/organization; that is, the sponsorship where you’re the sponsor. Only returns a sponsorship if it is active. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.

​
query_user_sponsorship_for_viewer_as_sponsorable 

query_user_sponsorship_for_viewer_as_sponsorable(login: str, github_credentials: GitHubCredentials, return_fields: Optional[Iterable[str]] = None) -> Dict[str, Any]
The sponsorship from this user/organization to the viewer; that is, the sponsorship you’re receiving. Only returns a sponsorship if it is active. Args:
  • login: The user’s login.
  • github_credentials: Credentials to use for authentication with GitHub.
  • return_fields: Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.
Returns:
  • A dict of the returned fields.