prefect_github.viewer

This is a module containing: GitHub query_viewer* tasks

Classes

Functions

query_viewer async

The query root of GitHub's GraphQL interface.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer(  # noqa
    github_credentials: GitHubCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    The query root of GitHub's GraphQL interface.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs())

    op_stack = ("viewer",)
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]

query_viewer_commit_comments async

A list of commit comments made by this user.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_commit_comments(  # noqa
    github_credentials: GitHubCredentials,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of commit comments made by this user.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).commit_comments(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "viewer",
        "commitComments",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["commitComments"]

query_viewer_contributions_collection async

The collection of contributions this user has made to different repositories.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
organization_id	str	The ID of the organization used to filter contributions.	None
from_	datetime	Only contributions made at this time or later will be counted. If omitted, defaults to a year ago.	None
to	datetime	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.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_contributions_collection(  # noqa
    github_credentials: GitHubCredentials,
    organization_id: str = None,
    from_: datetime = None,
    to: datetime = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    The collection of contributions this user has made to different repositories.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).contributions_collection(
        **strip_kwargs(
            organization_id=organization_id,
            from_=from_,
            to=to,
        )
    )

    op_stack = (
        "viewer",
        "contributionsCollection",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["contributionsCollection"]

query_viewer_followers async

A list of users the given user is followed by.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_followers(  # noqa
    github_credentials: GitHubCredentials,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of users the given user is followed by.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).followers(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "viewer",
        "followers",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["followers"]

query_viewer_following async

A list of users the given user is following.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_following(  # noqa
    github_credentials: GitHubCredentials,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of users the given user is following.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).following(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "viewer",
        "following",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["following"]

query_viewer_gist async

Find gist by repo name.

Parameters:

Name	Type	Description	Default
name	str	The gist name to find.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_gist(  # noqa
    name: str,
    github_credentials: GitHubCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Find gist by repo name.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).gist(
        **strip_kwargs(
            name=name,
        )
    )

    op_stack = (
        "viewer",
        "gist",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["gist"]

query_viewer_gist_comments async

A list of gist comments made by this user.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_gist_comments(  # noqa
    github_credentials: GitHubCredentials,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of gist comments made by this user.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).gist_comments(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "viewer",
        "gistComments",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["gistComments"]

query_viewer_gists async

A list of the Gists the user has created.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
privacy	GistPrivacy	Filters Gists according to privacy.	None
order_by	GistOrder	Ordering options for gists returned from the connection.	None
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_gists(  # noqa
    github_credentials: GitHubCredentials,
    privacy: graphql_schema.GistPrivacy = None,
    order_by: graphql_schema.GistOrder = None,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of the Gists the user has created.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).gists(
        **strip_kwargs(
            privacy=privacy,
            order_by=order_by,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "viewer",
        "gists",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["gists"]

query_viewer_interaction_ability async

The interaction ability settings for this user.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_interaction_ability(  # noqa
    github_credentials: GitHubCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    The interaction ability settings for this user.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).interaction_ability(**strip_kwargs())

    op_stack = (
        "viewer",
        "interactionAbility",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["interactionAbility"]

query_viewer_issue_comments async

A list of issue comments made by this user.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
order_by	IssueCommentOrder	Ordering options for issue comments returned from the connection.	None
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_issue_comments(  # noqa
    github_credentials: GitHubCredentials,
    order_by: graphql_schema.IssueCommentOrder = None,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of issue comments made by this user.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).issue_comments(
        **strip_kwargs(
            order_by=order_by,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "viewer",
        "issueComments",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["issueComments"]

query_viewer_issues async

A list of issues associated with this user.

Parameters:

Name	Type	Description	Default
labels	Iterable[str]	A list of label names to filter the pull requests by.	required
states	Iterable[IssueState]	A list of states to filter the issues by.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
order_by	IssueOrder	Ordering options for issues returned from the connection.	None
filter_by	IssueFilters	Filtering options for issues returned from the connection.	None
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_issues(  # noqa
    labels: Iterable[str],
    states: Iterable[graphql_schema.IssueState],
    github_credentials: GitHubCredentials,
    order_by: graphql_schema.IssueOrder = None,
    filter_by: graphql_schema.IssueFilters = None,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of issues associated with this user.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).issues(
        **strip_kwargs(
            labels=labels,
            states=states,
            order_by=order_by,
            filter_by=filter_by,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "viewer",
        "issues",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["issues"]

query_viewer_item_showcase async

Showcases a selection of repositories and gists that the profile owner has either curated or that have been selected automatically based on popularity.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_item_showcase(  # noqa
    github_credentials: GitHubCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Showcases a selection of repositories and gists that the profile owner has
    either curated or that have been selected automatically based on popularity.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).item_showcase(**strip_kwargs())

    op_stack = (
        "viewer",
        "itemShowcase",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["itemShowcase"]

query_viewer_organization async

Find an organization by its login that the user belongs to.

Parameters:

Name	Type	Description	Default
login	str	The login of the organization to find.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_organization(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Find an organization by its login that the user belongs to.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).organization(
        **strip_kwargs(
            login=login,
        )
    )

    op_stack = (
        "viewer",
        "organization",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["organization"]

query_viewer_organizations async

A list of organizations the user belongs to.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_organizations(  # noqa
    github_credentials: GitHubCredentials,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of organizations the user belongs to.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).organizations(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "viewer",
        "organizations",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["organizations"]

query_viewer_packages async

A list of packages under the owner.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
names	Iterable[str]	Find packages by their names.	None
repository_id	str	Find packages in a repository by ID.	None
package_type	PackageType	Filter registry package by type.	None
order_by	PackageOrder	Ordering of the returned packages.	{'field': 'CREATED_AT', 'direction': 'DESC'}
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_packages(  # noqa
    github_credentials: GitHubCredentials,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    names: Iterable[str] = None,
    repository_id: str = None,
    package_type: graphql_schema.PackageType = None,
    order_by: graphql_schema.PackageOrder = {
        "field": "CREATED_AT",
        "direction": "DESC",
    },
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of packages under the owner.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).packages(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            names=names,
            repository_id=repository_id,
            package_type=package_type,
            order_by=order_by,
        )
    )

    op_stack = (
        "viewer",
        "packages",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["packages"]

query_viewer_pinnable_items async

A list of repositories and gists this profile owner can pin to their profile.

Parameters:

Name	Type	Description	Default
types	Iterable[PinnableItemType]	Filter the types of pinnable items that are returned.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_pinnable_items(  # noqa
    types: Iterable[graphql_schema.PinnableItemType],
    github_credentials: GitHubCredentials,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of repositories and gists this profile owner can pin to their profile.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).pinnable_items(
        **strip_kwargs(
            types=types,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "viewer",
        "pinnableItems",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["pinnableItems"]

query_viewer_pinned_items async

A list of repositories and gists this profile owner has pinned to their profile.

Parameters:

Name	Type	Description	Default
types	Iterable[PinnableItemType]	Filter the types of pinned items that are returned.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_pinned_items(  # noqa
    types: Iterable[graphql_schema.PinnableItemType],
    github_credentials: GitHubCredentials,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of repositories and gists this profile owner has pinned to their profile.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).pinned_items(
        **strip_kwargs(
            types=types,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "viewer",
        "pinnedItems",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["pinnedItems"]

query_viewer_project async

Find project by number.

Parameters:

Name	Type	Description	Default
number	int	The project number to find.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_project(  # noqa
    number: int,
    github_credentials: GitHubCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Find project by number.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).project(
        **strip_kwargs(
            number=number,
        )
    )

    op_stack = (
        "viewer",
        "project",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["project"]

query_viewer_project_next async

Find a project by project (beta) number.

Parameters:

Name	Type	Description	Default
number	int	The project (beta) number.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_project_next(  # noqa
    number: int,
    github_credentials: GitHubCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Find a project by project (beta) number.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).project_next(
        **strip_kwargs(
            number=number,
        )
    )

    op_stack = (
        "viewer",
        "projectNext",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["projectNext"]

query_viewer_project_v2 async

Find a project by number.

Parameters:

Name	Type	Description	Default
number	int	The project number.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_project_v2(  # noqa
    number: int,
    github_credentials: GitHubCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Find a project by number.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).project_v2(
        **strip_kwargs(
            number=number,
        )
    )

    op_stack = (
        "viewer",
        "projectV2",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["projectV2"]

query_viewer_projects async

A list of projects under the owner.

Parameters:

Name	Type	Description	Default
states	Iterable[ProjectState]	A list of states to filter the projects by.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
order_by	ProjectOrder	Ordering options for projects returned from the connection.	None
search	str	Query to search projects by, currently only searching by name.	None
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_projects(  # noqa
    states: Iterable[graphql_schema.ProjectState],
    github_credentials: GitHubCredentials,
    order_by: graphql_schema.ProjectOrder = None,
    search: str = None,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of projects under the owner.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).projects(
        **strip_kwargs(
            states=states,
            order_by=order_by,
            search=search,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "viewer",
        "projects",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["projects"]

query_viewer_projects_next async

A list of projects (beta) under the owner.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
query	str	A project (beta) to search for under the the owner.	None
sort_by	ProjectNextOrderField	How to order the returned projects (beta).	'TITLE'
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_projects_next(  # noqa
    github_credentials: GitHubCredentials,
    query: str = None,
    sort_by: graphql_schema.ProjectNextOrderField = "TITLE",
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of projects (beta) under the owner.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).projects_next(
        **strip_kwargs(
            query=query,
            sort_by=sort_by,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "viewer",
        "projectsNext",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["projectsNext"]

query_viewer_projects_v2 async

A list of projects under the owner.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
query	str	A project to search for under the the owner.	None
order_by	ProjectV2Order	How to order the returned projects.	{'field': 'NUMBER', 'direction': 'DESC'}
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_projects_v2(  # noqa
    github_credentials: GitHubCredentials,
    query: str = None,
    order_by: graphql_schema.ProjectV2Order = {"field": "NUMBER", "direction": "DESC"},
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of projects under the owner.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).projects_v2(
        **strip_kwargs(
            query=query,
            order_by=order_by,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "viewer",
        "projectsV2",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["projectsV2"]

query_viewer_public_keys async

A list of public keys associated with this user.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_public_keys(  # noqa
    github_credentials: GitHubCredentials,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of public keys associated with this user.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).public_keys(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "viewer",
        "publicKeys",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["publicKeys"]

query_viewer_pull_requests async

A list of pull requests associated with this user.

Parameters:

Name	Type	Description	Default
states	Iterable[PullRequestState]	A list of states to filter the pull requests by.	required
labels	Iterable[str]	A list of label names to filter the pull requests by.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
head_ref_name	str	The head ref name to filter the pull requests by.	None
base_ref_name	str	The base ref name to filter the pull requests by.	None
order_by	IssueOrder	Ordering options for pull requests returned from the connection.	None
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_pull_requests(  # noqa
    states: Iterable[graphql_schema.PullRequestState],
    labels: Iterable[str],
    github_credentials: GitHubCredentials,
    head_ref_name: str = None,
    base_ref_name: str = None,
    order_by: graphql_schema.IssueOrder = None,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of pull requests associated with this user.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).pull_requests(
        **strip_kwargs(
            states=states,
            labels=labels,
            head_ref_name=head_ref_name,
            base_ref_name=base_ref_name,
            order_by=order_by,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "viewer",
        "pullRequests",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["pullRequests"]

query_viewer_recent_projects async

Recent projects that this user has modified in the context of the owner.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_recent_projects(  # noqa
    github_credentials: GitHubCredentials,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Recent projects that this user has modified in the context of the owner.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).recent_projects(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "viewer",
        "recentProjects",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["recentProjects"]

query_viewer_repositories async

A list of repositories that the user owns.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
privacy	RepositoryPrivacy	If non-null, filters repositories according to privacy.	None
order_by	RepositoryOrder	Ordering options for repositories returned from the connection.	None
affiliations	Iterable[RepositoryAffiliation]	Array of viewer's affiliation options for repositories returned from the connection. For example, OWNER will include only repositories that the current viewer owns.	None
owner_affiliations	Iterable[RepositoryAffiliation]	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.	('OWNER', 'COLLABORATOR')
is_locked	bool	If non-null, filters repositories according to whether they have been locked.	None
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
is_fork	bool	If non-null, filters repositories according to whether they are forks of another repository.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_repositories(  # noqa
    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: bool = None,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    is_fork: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of repositories that the user owns.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).repositories(
        **strip_kwargs(
            privacy=privacy,
            order_by=order_by,
            affiliations=affiliations,
            owner_affiliations=owner_affiliations,
            is_locked=is_locked,
            after=after,
            before=before,
            first=first,
            last=last,
            is_fork=is_fork,
        )
    )

    op_stack = (
        "viewer",
        "repositories",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["repositories"]

query_viewer_repositories_contributed_to async

A list of repositories that the user recently contributed to.

Parameters:

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

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_repositories_contributed_to(  # noqa
    github_credentials: GitHubCredentials,
    privacy: graphql_schema.RepositoryPrivacy = None,
    order_by: graphql_schema.RepositoryOrder = None,
    is_locked: bool = None,
    include_user_repositories: bool = None,
    contribution_types: Iterable[graphql_schema.RepositoryContributionType] = None,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of repositories that the user recently contributed to.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).repositories_contributed_to(
        **strip_kwargs(
            privacy=privacy,
            order_by=order_by,
            is_locked=is_locked,
            include_user_repositories=include_user_repositories,
            contribution_types=contribution_types,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "viewer",
        "repositoriesContributedTo",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["repositoriesContributedTo"]

query_viewer_repository async

Find Repository.

Parameters:

Name	Type	Description	Default
name	str	Name of Repository to find.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
follow_renames	bool	Follow repository renames. If disabled, a repository referenced by its old name will return an error.	True
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_repository(  # noqa
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Find Repository.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).repository(
        **strip_kwargs(
            name=name,
            follow_renames=follow_renames,
        )
    )

    op_stack = (
        "viewer",
        "repository",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["repository"]

query_viewer_repository_discussion_comments async

Discussion comments this user has authored.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
repository_id	str	Filter discussion comments to only those in a specific repository.	None
only_answers	bool	Filter discussion comments to only those that were marked as the answer.	False
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_repository_discussion_comments(  # noqa
    github_credentials: GitHubCredentials,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    repository_id: str = None,
    only_answers: bool = False,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Discussion comments this user has authored.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).repository_discussion_comments(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            repository_id=repository_id,
            only_answers=only_answers,
        )
    )

    op_stack = (
        "viewer",
        "repositoryDiscussionComments",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["repositoryDiscussionComments"]

query_viewer_repository_discussions async

Discussions this user has started.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
order_by	DiscussionOrder	Ordering options for discussions returned from the connection.	{'field': 'CREATED_AT', 'direction': 'DESC'}
repository_id	str	Filter discussions to only those in a specific repository.	None
answered	bool	Filter discussions to only those that have been answered or not. Defaults to including both answered and unanswered discussions.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_repository_discussions(  # noqa
    github_credentials: GitHubCredentials,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    order_by: graphql_schema.DiscussionOrder = {
        "field": "CREATED_AT",
        "direction": "DESC",
    },
    repository_id: str = None,
    answered: bool = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Discussions this user has started.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).repository_discussions(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            order_by=order_by,
            repository_id=repository_id,
            answered=answered,
        )
    )

    op_stack = (
        "viewer",
        "repositoryDiscussions",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["repositoryDiscussions"]

query_viewer_saved_replies async

Replies this user has saved.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
order_by	SavedReplyOrder	The field to order saved replies by.	{'field': 'UPDATED_AT', 'direction': 'DESC'}
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_saved_replies(  # noqa
    github_credentials: GitHubCredentials,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    order_by: graphql_schema.SavedReplyOrder = {
        "field": "UPDATED_AT",
        "direction": "DESC",
    },
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Replies this user has saved.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).saved_replies(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            order_by=order_by,
        )
    )

    op_stack = (
        "viewer",
        "savedReplies",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["savedReplies"]

query_viewer_sponsoring async

List of users and organizations this entity is sponsoring.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
order_by	SponsorOrder	Ordering options for the users and organizations returned from the connection.	{'field': 'RELEVANCE', 'direction': 'DESC'}
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_sponsoring(  # noqa
    github_credentials: GitHubCredentials,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    order_by: graphql_schema.SponsorOrder = {"field": "RELEVANCE", "direction": "DESC"},
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    List of users and organizations this entity is sponsoring.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).sponsoring(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            order_by=order_by,
        )
    )

    op_stack = (
        "viewer",
        "sponsoring",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["sponsoring"]

query_viewer_sponsors async

List of sponsors for this user or organization.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
tier_id	str	If given, will filter for sponsors at the given tier. Will only return sponsors whose tier the viewer is permitted to see.	None
order_by	SponsorOrder	Ordering options for sponsors returned from the connection.	{'field': 'RELEVANCE', 'direction': 'DESC'}
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_sponsors(  # noqa
    github_credentials: GitHubCredentials,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    tier_id: str = None,
    order_by: graphql_schema.SponsorOrder = {"field": "RELEVANCE", "direction": "DESC"},
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    List of sponsors for this user or organization.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).sponsors(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            tier_id=tier_id,
            order_by=order_by,
        )
    )

    op_stack = (
        "viewer",
        "sponsors",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["sponsors"]

query_viewer_sponsors_activities async

Events involving this sponsorable, such as new sponsorships.

Parameters:

Name	Type	Description	Default
actions	Iterable[SponsorsActivityAction]	Filter activities to only the specified actions.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
period	SponsorsActivityPeriod	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.	'MONTH'
order_by	SponsorsActivityOrder	Ordering options for activity returned from the connection.	{'field': 'TIMESTAMP', 'direction': 'DESC'}
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_sponsors_activities(  # noqa
    actions: Iterable[graphql_schema.SponsorsActivityAction],
    github_credentials: GitHubCredentials,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    period: graphql_schema.SponsorsActivityPeriod = "MONTH",
    order_by: graphql_schema.SponsorsActivityOrder = {
        "field": "TIMESTAMP",
        "direction": "DESC",
    },
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Events involving this sponsorable, such as new sponsorships.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).sponsors_activities(
        **strip_kwargs(
            actions=actions,
            after=after,
            before=before,
            first=first,
            last=last,
            period=period,
            order_by=order_by,
        )
    )

    op_stack = (
        "viewer",
        "sponsorsActivities",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["sponsorsActivities"]

query_viewer_sponsors_listing async

The GitHub Sponsors listing for this user or organization.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_sponsors_listing(  # noqa
    github_credentials: GitHubCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    The GitHub Sponsors listing for this user or organization.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).sponsors_listing(**strip_kwargs())

    op_stack = (
        "viewer",
        "sponsorsListing",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["sponsorsListing"]

query_viewer_sponsorship_for_viewer_as_sponsor async

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.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_sponsorship_for_viewer_as_sponsor(  # noqa
    github_credentials: GitHubCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    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:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).sponsorship_for_viewer_as_sponsor(
        **strip_kwargs()
    )

    op_stack = (
        "viewer",
        "sponsorshipForViewerAsSponsor",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["sponsorshipForViewerAsSponsor"]

query_viewer_sponsorship_for_viewer_as_sponsorable async

The sponsorship from this user/organization to the viewer; that is, the sponsorship you're receiving. Only returns a sponsorship if it is active.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_sponsorship_for_viewer_as_sponsorable(  # noqa
    github_credentials: GitHubCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    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:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).sponsorship_for_viewer_as_sponsorable(
        **strip_kwargs()
    )

    op_stack = (
        "viewer",
        "sponsorshipForViewerAsSponsorable",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["sponsorshipForViewerAsSponsorable"]

query_viewer_sponsorship_newsletters async

List of sponsorship updates sent from this sponsorable to sponsors.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
order_by	SponsorshipNewsletterOrder	Ordering options for sponsorship updates returned from the connection.	{'field': 'CREATED_AT', 'direction': 'DESC'}
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_sponsorship_newsletters(  # noqa
    github_credentials: GitHubCredentials,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    order_by: graphql_schema.SponsorshipNewsletterOrder = {
        "field": "CREATED_AT",
        "direction": "DESC",
    },
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    List of sponsorship updates sent from this sponsorable to sponsors.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).sponsorship_newsletters(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            order_by=order_by,
        )
    )

    op_stack = (
        "viewer",
        "sponsorshipNewsletters",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["sponsorshipNewsletters"]

query_viewer_sponsorships_as_maintainer async

This object's sponsorships as the maintainer.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
include_private	bool	Whether or not to include private sponsorships in the result set.	False
order_by	SponsorshipOrder	Ordering options for sponsorships returned from this connection. If left blank, the sponsorships will be ordered based on relevancy to the viewer.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_sponsorships_as_maintainer(  # noqa
    github_credentials: GitHubCredentials,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    include_private: bool = False,
    order_by: graphql_schema.SponsorshipOrder = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    This object's sponsorships as the maintainer.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).sponsorships_as_maintainer(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            include_private=include_private,
            order_by=order_by,
        )
    )

    op_stack = (
        "viewer",
        "sponsorshipsAsMaintainer",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["sponsorshipsAsMaintainer"]

query_viewer_sponsorships_as_sponsor async

This object's sponsorships as the sponsor.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
order_by	SponsorshipOrder	Ordering options for sponsorships returned from this connection. If left blank, the sponsorships will be ordered based on relevancy to the viewer.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_sponsorships_as_sponsor(  # noqa
    github_credentials: GitHubCredentials,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    order_by: graphql_schema.SponsorshipOrder = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    This object's sponsorships as the sponsor.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).sponsorships_as_sponsor(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            order_by=order_by,
        )
    )

    op_stack = (
        "viewer",
        "sponsorshipsAsSponsor",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["sponsorshipsAsSponsor"]

query_viewer_starred_repositories async

Repositories the user has starred.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
owned_by_viewer	bool	Filters starred repositories to only return repositories owned by the viewer.	None
order_by	StarOrder	Order for connection.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_starred_repositories(  # noqa
    github_credentials: GitHubCredentials,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    owned_by_viewer: bool = None,
    order_by: graphql_schema.StarOrder = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Repositories the user has starred.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).starred_repositories(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            owned_by_viewer=owned_by_viewer,
            order_by=order_by,
        )
    )

    op_stack = (
        "viewer",
        "starredRepositories",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["starredRepositories"]

query_viewer_status async

The user's description of what they're currently doing.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_status(  # noqa
    github_credentials: GitHubCredentials,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    The user's description of what they're currently doing.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).status(**strip_kwargs())

    op_stack = (
        "viewer",
        "status",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["status"]

query_viewer_top_repositories async

Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created.

Parameters:

Name	Type	Description	Default
order_by	RepositoryOrder	Ordering options for repositories returned from the connection.	required
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
since	datetime	How far back in time to fetch contributed repositories.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_top_repositories(  # noqa
    order_by: graphql_schema.RepositoryOrder,
    github_credentials: GitHubCredentials,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    since: datetime = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Repositories the user has contributed to, ordered by contribution rank, plus
    repositories the user has created.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).top_repositories(
        **strip_kwargs(
            order_by=order_by,
            after=after,
            before=before,
            first=first,
            last=last,
            since=since,
        )
    )

    op_stack = (
        "viewer",
        "topRepositories",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["topRepositories"]

query_viewer_watching async

A list of repositories the given user is watching.

Parameters:

Name	Type	Description	Default
github_credentials	GitHubCredentials	Credentials to use for authentication with GitHub.	required
privacy	RepositoryPrivacy	If non-null, filters repositories according to privacy.	None
order_by	RepositoryOrder	Ordering options for repositories returned from the connection.	None
affiliations	Iterable[RepositoryAffiliation]	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.	None
owner_affiliations	Iterable[RepositoryAffiliation]	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.	('OWNER', 'COLLABORATOR')
is_locked	bool	If non-null, filters repositories according to whether they have been locked.	None
after	str	Returns the elements in the list that come after the specified cursor.	None
before	str	Returns the elements in the list that come before the specified cursor.	None
first	int	Returns the first n elements from the list.	None
last	int	Returns the last n elements from the list.	None
return_fields	Iterable[str]	Subset the return fields (as snake_case); defaults to fields listed in configs/query/*.json.	None

Returns:

Type	Description
Dict[str, Any]	A dict of the returned fields.

Source code in prefect_github/viewer.py

@task
async def query_viewer_watching(  # noqa
    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: bool = None,
    after: str = None,
    before: str = None,
    first: int = None,
    last: int = None,
    return_fields: Iterable[str] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of repositories the given user is watching.

    Args:
        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.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.viewer(**strip_kwargs()).watching(
        **strip_kwargs(
            privacy=privacy,
            order_by=order_by,
            affiliations=affiliations,
            owner_affiliations=owner_affiliations,
            is_locked=is_locked,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "viewer",
        "watching",
    )
    op_selection = _subset_return_fields(
        op_selection, op_stack, return_fields, return_fields_defaults
    )

    result = await _execute_graphql_op(op, github_credentials)
    return result["viewer"]["watching"]