Skip to content

prefect_github.user

This is a module containing: GitHub query_user* tasks

query_user(login, github_credentials, return_fields=None) async

The query root of GitHub's GraphQL interface.

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
return_fields Optional[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/user.py
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
@task
async def query_user(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    The query root of GitHub's GraphQL interface.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    )

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

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

query_user_commit_comments(login, github_credentials, after=None, before=None, first=None, last=None, return_fields=None) async

A list of commit comments made by this user.

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
return_fields Optional[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/user.py
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
@task
async def query_user_commit_comments(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of commit comments made by this user.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        after: Returns the elements in the list that come after
            the specified cursor.
        before: Returns the elements in the list that come
            before the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).commit_comments(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "user",
        "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["user"]["commitComments"]

query_user_contributions_collection(login, github_credentials, organization_id=None, from_=None, to=None, return_fields=None) async

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

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
organization_id Optional[str]

The ID of the organization used to filter contributions.

None
from_ Optional[datetime]

Only contributions made at this time or later will be counted. If omitted, defaults to a year ago.

None
to Optional[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 Optional[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/user.py
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
@task
async def query_user_contributions_collection(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    organization_id: Optional[str] = None,
    from_: Optional[datetime] = None,
    to: Optional[datetime] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    The collection of contributions this user has made to different repositories.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        organization_id: The ID of the organization
            used to filter contributions.
        from_: Only contributions made at this time or
            later will be counted. If omitted, defaults to a year ago.
        to: Only contributions made before and up to
            (including) this time will be counted. If omitted, defaults
            to the current time or one year from the provided from
            argument.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).contributions_collection(
        **strip_kwargs(
            organization_id=organization_id,
            from_=from_,
            to=to,
        )
    )

    op_stack = (
        "user",
        "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["user"]["contributionsCollection"]

query_user_followers(login, github_credentials, after=None, before=None, first=None, last=None, return_fields=None) async

A list of users the given user is followed by.

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
return_fields Optional[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/user.py
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
@task
async def query_user_followers(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of users the given user is followed by.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before the
            specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).followers(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "user",
        "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["user"]["followers"]

query_user_following(login, github_credentials, after=None, before=None, first=None, last=None, return_fields=None) async

A list of users the given user is following.

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
return_fields Optional[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/user.py
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
@task
async def query_user_following(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of users the given user is following.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before the
            specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).following(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "user",
        "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["user"]["following"]

query_user_gist(login, name, github_credentials, return_fields=None) async

Find gist by repo name.

Parameters:

Name Type Description Default
login str

The user's login.

required
name str

The gist name to find.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
return_fields Optional[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/user.py
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
@task
async def query_user_gist(  # noqa
    login: str,
    name: str,
    github_credentials: GitHubCredentials,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Find gist by repo name.

    Args:
        login: The user's login.
        name: The gist name to find.
        github_credentials: Credentials to use for authentication with GitHub.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).gist(
        **strip_kwargs(
            name=name,
        )
    )

    op_stack = (
        "user",
        "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["user"]["gist"]

query_user_gist_comments(login, github_credentials, after=None, before=None, first=None, last=None, return_fields=None) async

A list of gist comments made by this user.

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
return_fields Optional[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/user.py
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
@task
async def query_user_gist_comments(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of gist comments made by this user.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        after: Returns the elements in the list that come after
            the specified cursor.
        before: Returns the elements in the list that come before
            the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).gist_comments(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "user",
        "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["user"]["gistComments"]

query_user_gists(login, github_credentials, privacy=None, order_by=None, after=None, before=None, first=None, last=None, return_fields=None) async

A list of the Gists the user has created.

Parameters:

Name Type Description Default
login str

The user's login.

required
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 Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
return_fields Optional[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/user.py
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
@task
async def query_user_gists(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    privacy: graphql_schema.GistPrivacy = None,
    order_by: graphql_schema.GistOrder = None,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of the Gists the user has created.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        privacy: Filters Gists according to privacy.
        order_by: Ordering options for gists returned from the connection.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before the
            specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).gists(
        **strip_kwargs(
            privacy=privacy,
            order_by=order_by,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "user",
        "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["user"]["gists"]

query_user_interaction_ability(login, github_credentials, return_fields=None) async

The interaction ability settings for this user.

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
return_fields Optional[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/user.py
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
@task
async def query_user_interaction_ability(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    The interaction ability settings for this user.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).interaction_ability(**strip_kwargs())

    op_stack = (
        "user",
        "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["user"]["interactionAbility"]

query_user_issue_comments(login, github_credentials, order_by=None, after=None, before=None, first=None, last=None, return_fields=None) async

A list of issue comments made by this user.

Parameters:

Name Type Description Default
login str

The user's login.

required
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 Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
return_fields Optional[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/user.py
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
@task
async def query_user_issue_comments(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    order_by: graphql_schema.IssueCommentOrder = None,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of issue comments made by this user.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        order_by: Ordering options for issue comments returned
            from the connection.
        after: Returns the elements in the list that come after
            the specified cursor.
        before: Returns the elements in the list that come before
            the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).issue_comments(
        **strip_kwargs(
            order_by=order_by,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "user",
        "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["user"]["issueComments"]

query_user_issues(login, labels, states, github_credentials, order_by=None, filter_by=None, after=None, before=None, first=None, last=None, return_fields=None) async

A list of issues associated with this user.

Parameters:

Name Type Description Default
login str

The user's login.

required
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 Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
return_fields Optional[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/user.py
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
@task
async def query_user_issues(  # noqa
    login: str,
    labels: Iterable[str],
    states: Iterable[graphql_schema.IssueState],
    github_credentials: GitHubCredentials,
    order_by: graphql_schema.IssueOrder = None,
    filter_by: graphql_schema.IssueFilters = None,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of issues associated with this user.

    Args:
        login: The user's login.
        labels: A list of label names to filter the pull requests by.
        states: A list of states to filter the issues by.
        github_credentials: Credentials to use for authentication with GitHub.
        order_by: Ordering options for issues returned from the
            connection.
        filter_by: Filtering options for issues returned from the
            connection.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before the
            specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).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 = (
        "user",
        "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["user"]["issues"]

query_user_item_showcase(login, github_credentials, return_fields=None) 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
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
return_fields Optional[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/user.py
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
@task
async def query_user_item_showcase(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    return_fields: Optional[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:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).item_showcase(**strip_kwargs())

    op_stack = (
        "user",
        "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["user"]["itemShowcase"]

query_user_organization(login, organization_login, github_credentials, return_fields=None) async

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

Parameters:

Name Type Description Default
login str

The user's login.

required
organization_login str

The login of the organization to find.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
return_fields Optional[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/user.py
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
@task
async def query_user_organization(  # noqa
    login: str,
    organization_login: str,
    github_credentials: GitHubCredentials,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Find an organization by its login that the user belongs to.

    Args:
        login: The user's login.
        organization_login: The login of the organization to find.
        github_credentials: Credentials to use for authentication with GitHub.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).organization(
        **strip_kwargs(
            login=organization_login,
        )
    )

    op_stack = (
        "user",
        "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["user"]["organization"]

query_user_organizations(login, github_credentials, after=None, before=None, first=None, last=None, return_fields=None) async

A list of organizations the user belongs to.

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
return_fields Optional[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/user.py
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
@task
async def query_user_organizations(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of organizations the user belongs to.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        after: Returns the elements in the list that come after
            the specified cursor.
        before: Returns the elements in the list that come before
            the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).organizations(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "user",
        "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["user"]["organizations"]

query_user_packages(login, github_credentials, after=None, before=None, first=None, last=None, names=None, repository_id=None, package_type=None, order_by={'field': 'CREATED_AT', 'direction': 'DESC'}, return_fields=None) async

A list of packages under the owner.

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
names Optional[Iterable[str]]

Find packages by their names.

None
repository_id Optional[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 Optional[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/user.py
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
@task
async def query_user_packages(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    names: Optional[Iterable[str]] = None,
    repository_id: Optional[str] = None,
    package_type: graphql_schema.PackageType = None,
    order_by: graphql_schema.PackageOrder = {
        "field": "CREATED_AT",
        "direction": "DESC",
    },
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of packages under the owner.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before the
            specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        names: Find packages by their names.
        repository_id: Find packages in a repository by ID.
        package_type: Filter registry package by type.
        order_by: Ordering of the returned packages.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).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 = (
        "user",
        "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["user"]["packages"]

query_user_pinnable_items(login, types, github_credentials, after=None, before=None, first=None, last=None, return_fields=None) async

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

Parameters:

Name Type Description Default
login str

The user's login.

required
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 Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
return_fields Optional[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/user.py
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
@task
async def query_user_pinnable_items(  # noqa
    login: str,
    types: Iterable[graphql_schema.PinnableItemType],
    github_credentials: GitHubCredentials,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of repositories and gists this profile owner can pin to their profile.

    Args:
        login: The user's login.
        types: Filter the types of pinnable items that are
            returned.
        github_credentials: Credentials to use for authentication with GitHub.
        after: Returns the elements in the list that come after
            the specified cursor.
        before: Returns the elements in the list that come before
            the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).pinnable_items(
        **strip_kwargs(
            types=types,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "user",
        "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["user"]["pinnableItems"]

query_user_pinned_items(login, types, github_credentials, after=None, before=None, first=None, last=None, return_fields=None) async

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

Parameters:

Name Type Description Default
login str

The user's login.

required
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 Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
return_fields Optional[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/user.py
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
@task
async def query_user_pinned_items(  # noqa
    login: str,
    types: Iterable[graphql_schema.PinnableItemType],
    github_credentials: GitHubCredentials,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of repositories and gists this profile owner has pinned to their profile.

    Args:
        login: The user's login.
        types: Filter the types of pinned items that are returned.
        github_credentials: Credentials to use for authentication with GitHub.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before
            the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).pinned_items(
        **strip_kwargs(
            types=types,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "user",
        "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["user"]["pinnedItems"]

query_user_project(login, number, github_credentials, return_fields=None) async

Find project by number.

Parameters:

Name Type Description Default
login str

The user's login.

required
number int

The project number to find.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
return_fields Optional[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/user.py
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
@task
async def query_user_project(  # noqa
    login: str,
    number: int,
    github_credentials: GitHubCredentials,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Find project by number.

    Args:
        login: The user's login.
        number: The project number to find.
        github_credentials: Credentials to use for authentication with GitHub.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).project(
        **strip_kwargs(
            number=number,
        )
    )

    op_stack = (
        "user",
        "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["user"]["project"]

query_user_project_next(login, number, github_credentials, return_fields=None) async

Find a project by project (beta) number.

Parameters:

Name Type Description Default
login str

The user's login.

required
number int

The project (beta) number.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
return_fields Optional[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/user.py
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
@task
async def query_user_project_next(  # noqa
    login: str,
    number: int,
    github_credentials: GitHubCredentials,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Find a project by project (beta) number.

    Args:
        login: The user's login.
        number: The project (beta) number.
        github_credentials: Credentials to use for authentication with GitHub.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).project_next(
        **strip_kwargs(
            number=number,
        )
    )

    op_stack = (
        "user",
        "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["user"]["projectNext"]

query_user_project_v2(login, number, github_credentials, return_fields=None) async

Find a project by number.

Parameters:

Name Type Description Default
login str

The user's login.

required
number int

The project number.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
return_fields Optional[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/user.py
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
@task
async def query_user_project_v2(  # noqa
    login: str,
    number: int,
    github_credentials: GitHubCredentials,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Find a project by number.

    Args:
        login: The user's login.
        number: The project number.
        github_credentials: Credentials to use for authentication with GitHub.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).project_v2(
        **strip_kwargs(
            number=number,
        )
    )

    op_stack = (
        "user",
        "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["user"]["projectV2"]

query_user_projects(login, states, github_credentials, order_by=None, search=None, after=None, before=None, first=None, last=None, return_fields=None) async

A list of projects under the owner.

Parameters:

Name Type Description Default
login str

The user's login.

required
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 Optional[str]

Query to search projects by, currently only searching by name.

None
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
return_fields Optional[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/user.py
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
@task
async def query_user_projects(  # noqa
    login: str,
    states: Iterable[graphql_schema.ProjectState],
    github_credentials: GitHubCredentials,
    order_by: graphql_schema.ProjectOrder = None,
    search: Optional[str] = None,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of projects under the owner.

    Args:
        login: The user's login.
        states: A list of states to filter the projects by.
        github_credentials: Credentials to use for authentication with GitHub.
        order_by: Ordering options for projects returned from the
            connection.
        search: Query to search projects by, currently only searching
            by name.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before the
            specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).projects(
        **strip_kwargs(
            states=states,
            order_by=order_by,
            search=search,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "user",
        "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["user"]["projects"]

query_user_projects_next(login, github_credentials, query=None, sort_by='TITLE', after=None, before=None, first=None, last=None, return_fields=None) async

A list of projects (beta) under the owner.

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
query Optional[str]

A project (beta) to search for under the the owner.

None
sort_by ProjectNextOrderField

How to order the returned projects (beta).

'TITLE'
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
return_fields Optional[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/user.py
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
@task
async def query_user_projects_next(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    query: Optional[str] = None,
    sort_by: graphql_schema.ProjectNextOrderField = "TITLE",
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of projects (beta) under the owner.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        query: A project (beta) to search for under the the owner.
        sort_by: How to order the returned projects (beta).
        after: Returns the elements in the list that come after
            the specified cursor.
        before: Returns the elements in the list that come before
            the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).projects_next(
        **strip_kwargs(
            query=query,
            sort_by=sort_by,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "user",
        "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["user"]["projectsNext"]

query_user_projects_v2(login, github_credentials, query=None, order_by={'field': 'NUMBER', 'direction': 'DESC'}, after=None, before=None, first=None, last=None, return_fields=None) async

A list of projects under the owner.

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
query Optional[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 Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
return_fields Optional[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/user.py
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
@task
async def query_user_projects_v2(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    query: Optional[str] = None,
    order_by: graphql_schema.ProjectV2Order = {"field": "NUMBER", "direction": "DESC"},
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of projects under the owner.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        query: A project to search for under the the owner.
        order_by: How to order the returned projects.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before
            the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).projects_v2(
        **strip_kwargs(
            query=query,
            order_by=order_by,
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "user",
        "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["user"]["projectsV2"]

query_user_public_keys(login, github_credentials, after=None, before=None, first=None, last=None, return_fields=None) async

A list of public keys associated with this user.

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
return_fields Optional[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/user.py
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
@task
async def query_user_public_keys(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of public keys associated with this user.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before
            the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).public_keys(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "user",
        "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["user"]["publicKeys"]

query_user_pull_requests(login, states, labels, github_credentials, head_ref_name=None, base_ref_name=None, order_by=None, after=None, before=None, first=None, last=None, return_fields=None) async

A list of pull requests associated with this user.

Parameters:

Name Type Description Default
login str

The user's login.

required
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 Optional[str]

The head ref name to filter the pull requests by.

None
base_ref_name Optional[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 Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
return_fields Optional[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/user.py
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
@task
async def query_user_pull_requests(  # noqa
    login: str,
    states: Iterable[graphql_schema.PullRequestState],
    labels: Iterable[str],
    github_credentials: GitHubCredentials,
    head_ref_name: Optional[str] = None,
    base_ref_name: Optional[str] = None,
    order_by: graphql_schema.IssueOrder = None,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of pull requests associated with this user.

    Args:
        login: The user's login.
        states: A list of states to filter the pull requests by.
        labels: A list of label names to filter the pull requests
            by.
        github_credentials: Credentials to use for authentication with GitHub.
        head_ref_name: The head ref name to filter the pull
            requests by.
        base_ref_name: The base ref name to filter the pull
            requests by.
        order_by: Ordering options for pull requests returned from
            the connection.
        after: Returns the elements in the list that come after
            the specified cursor.
        before: Returns the elements in the list that come before
            the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).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 = (
        "user",
        "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["user"]["pullRequests"]

query_user_recent_projects(login, github_credentials, after=None, before=None, first=None, last=None, return_fields=None) async

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

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
return_fields Optional[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/user.py
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
@task
async def query_user_recent_projects(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Recent projects that this user has modified in the context of the owner.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        after: Returns the elements in the list that come after
            the specified cursor.
        before: Returns the elements in the list that come
            before the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).recent_projects(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
        )
    )

    op_stack = (
        "user",
        "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["user"]["recentProjects"]

query_user_repositories(login, github_credentials, privacy=None, order_by=None, affiliations=None, owner_affiliations=('OWNER', 'COLLABORATOR'), is_locked=None, after=None, before=None, first=None, last=None, is_fork=None, return_fields=None) async

A list of repositories that the user owns.

Parameters:

Name Type Description Default
login str

The user's login.

required
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 Optional[bool]

If non-null, filters repositories according to whether they have been locked.

None
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
is_fork Optional[bool]

If non-null, filters repositories according to whether they are forks of another repository.

None
return_fields Optional[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/user.py
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
@task
async def query_user_repositories(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    privacy: graphql_schema.RepositoryPrivacy = None,
    order_by: graphql_schema.RepositoryOrder = None,
    affiliations: Iterable[graphql_schema.RepositoryAffiliation] = None,
    owner_affiliations: Iterable[graphql_schema.RepositoryAffiliation] = (
        "OWNER",
        "COLLABORATOR",
    ),
    is_locked: Optional[bool] = None,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    is_fork: Optional[bool] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of repositories that the user owns.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        privacy: If non-null, filters repositories according to
            privacy.
        order_by: Ordering options for repositories returned from
            the connection.
        affiliations: Array of viewer's affiliation options for
            repositories returned from the connection. For example,
            OWNER will include only repositories that the current viewer
            owns.
        owner_affiliations: Array of owner's affiliation options
            for repositories returned from the connection. For example,
            OWNER will include only repositories that the organization
            or user being viewed owns.
        is_locked: If non-null, filters repositories according to
            whether they have been locked.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before
            the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        is_fork: If non-null, filters repositories according to
            whether they are forks of another repository.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).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 = (
        "user",
        "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["user"]["repositories"]

query_user_repositories_contributed_to(login, github_credentials, privacy=None, order_by=None, is_locked=None, include_user_repositories=None, contribution_types=None, after=None, before=None, first=None, last=None, return_fields=None) async

A list of repositories that the user recently contributed to.

Parameters:

Name Type Description Default
login str

The user's login.

required
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 Optional[bool]

If non-null, filters repositories according to whether they have been locked.

None
include_user_repositories Optional[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 Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
return_fields Optional[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/user.py
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
@task
async def query_user_repositories_contributed_to(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    privacy: graphql_schema.RepositoryPrivacy = None,
    order_by: graphql_schema.RepositoryOrder = None,
    is_locked: Optional[bool] = None,
    include_user_repositories: Optional[bool] = None,
    contribution_types: Iterable[graphql_schema.RepositoryContributionType] = None,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of repositories that the user recently contributed to.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        privacy: If non-null, filters repositories
            according to privacy.
        order_by: Ordering options for repositories
            returned from the connection.
        is_locked: If non-null, filters repositories
            according to whether they have been locked.
        include_user_repositories: If true, include
            user repositories.
        contribution_types: If non-null, include
            only the specified types of contributions. The GitHub.com UI
            uses [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY].
        after: Returns the elements in the list that
            come after the specified cursor.
        before: Returns the elements in the list
            that come before the specified cursor.
        first: Returns the first _n_ elements from
            the list.
        last: Returns the last _n_ elements from the
            list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).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 = (
        "user",
        "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["user"]["repositoriesContributedTo"]

query_user_repository(login, name, github_credentials, follow_renames=True, return_fields=None) async

Find Repository.

Parameters:

Name Type Description Default
login str

The user's login.

required
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 Optional[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/user.py
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
@task
async def query_user_repository(  # noqa
    login: str,
    name: str,
    github_credentials: GitHubCredentials,
    follow_renames: bool = True,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Find Repository.

    Args:
        login: The user's login.
        name: Name of Repository to find.
        github_credentials: Credentials to use for authentication with GitHub.
        follow_renames: Follow repository renames. If disabled, a
            repository referenced by its old name will return an error.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).repository(
        **strip_kwargs(
            name=name,
            follow_renames=follow_renames,
        )
    )

    op_stack = (
        "user",
        "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["user"]["repository"]

query_user_repository_discussion_comments(login, github_credentials, after=None, before=None, first=None, last=None, repository_id=None, only_answers=False, return_fields=None) async

Discussion comments this user has authored.

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
repository_id Optional[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 Optional[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/user.py
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
@task
async def query_user_repository_discussion_comments(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    repository_id: Optional[str] = None,
    only_answers: bool = False,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Discussion comments this user has authored.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        after: Returns the elements in the list
            that come after the specified cursor.
        before: Returns the elements in the list
            that come before the specified cursor.
        first: Returns the first _n_ elements
            from the list.
        last: Returns the last _n_ elements from
            the list.
        repository_id: Filter discussion comments
            to only those in a specific repository.
        only_answers: Filter discussion comments
            to only those that were marked as the answer.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).repository_discussion_comments(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            repository_id=repository_id,
            only_answers=only_answers,
        )
    )

    op_stack = (
        "user",
        "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["user"]["repositoryDiscussionComments"]

query_user_repository_discussions(login, github_credentials, after=None, before=None, first=None, last=None, order_by={'field': 'CREATED_AT', 'direction': 'DESC'}, repository_id=None, answered=None, return_fields=None) async

Discussions this user has started.

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[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 Optional[str]

Filter discussions to only those in a specific repository.

None
answered Optional[bool]

Filter discussions to only those that have been answered or not. Defaults to including both answered and unanswered discussions.

None
return_fields Optional[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/user.py
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
@task
async def query_user_repository_discussions(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    order_by: graphql_schema.DiscussionOrder = {
        "field": "CREATED_AT",
        "direction": "DESC",
    },
    repository_id: Optional[str] = None,
    answered: Optional[bool] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Discussions this user has started.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        after: Returns the elements in the list that come
            after the specified cursor.
        before: Returns the elements in the list that
            come before the specified cursor.
        first: Returns the first _n_ elements from the
            list.
        last: Returns the last _n_ elements from the
            list.
        order_by: Ordering options for discussions
            returned from the connection.
        repository_id: Filter discussions to only those
            in a specific repository.
        answered: Filter discussions to only those that
            have been answered or not. Defaults to including both
            answered and unanswered discussions.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).repository_discussions(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            order_by=order_by,
            repository_id=repository_id,
            answered=answered,
        )
    )

    op_stack = (
        "user",
        "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["user"]["repositoryDiscussions"]

query_user_saved_replies(login, github_credentials, after=None, before=None, first=None, last=None, order_by={'field': 'UPDATED_AT', 'direction': 'DESC'}, return_fields=None) async

Replies this user has saved.

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[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 Optional[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/user.py
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
@task
async def query_user_saved_replies(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    order_by: graphql_schema.SavedReplyOrder = {
        "field": "UPDATED_AT",
        "direction": "DESC",
    },
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Replies this user has saved.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        after: Returns the elements in the list that come after
            the specified cursor.
        before: Returns the elements in the list that come before
            the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        order_by: The field to order saved replies by.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).saved_replies(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            order_by=order_by,
        )
    )

    op_stack = (
        "user",
        "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["user"]["savedReplies"]

query_user_sponsoring(login, github_credentials, after=None, before=None, first=None, last=None, order_by={'field': 'RELEVANCE', 'direction': 'DESC'}, return_fields=None) async

List of users and organizations this entity is sponsoring.

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[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 Optional[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/user.py
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
@task
async def query_user_sponsoring(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    order_by: graphql_schema.SponsorOrder = {"field": "RELEVANCE", "direction": "DESC"},
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    List of users and organizations this entity is sponsoring.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before the
            specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        order_by: Ordering options for the users and organizations
            returned from the connection.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).sponsoring(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            order_by=order_by,
        )
    )

    op_stack = (
        "user",
        "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["user"]["sponsoring"]

query_user_sponsors(login, github_credentials, after=None, before=None, first=None, last=None, tier_id=None, order_by={'field': 'RELEVANCE', 'direction': 'DESC'}, return_fields=None) async

List of sponsors for this user or organization.

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
tier_id Optional[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 Optional[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/user.py
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
@task
async def query_user_sponsors(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    tier_id: Optional[str] = None,
    order_by: graphql_schema.SponsorOrder = {"field": "RELEVANCE", "direction": "DESC"},
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    List of sponsors for this user or organization.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before the
            specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        tier_id: If given, will filter for sponsors at the given tier.
            Will only return sponsors whose tier the viewer is permitted
            to see.
        order_by: Ordering options for sponsors returned from the
            connection.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).sponsors(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            tier_id=tier_id,
            order_by=order_by,
        )
    )

    op_stack = (
        "user",
        "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["user"]["sponsors"]

query_user_sponsors_activities(login, actions, github_credentials, after=None, before=None, first=None, last=None, period='MONTH', order_by={'field': 'TIMESTAMP', 'direction': 'DESC'}, return_fields=None) async

Events involving this sponsorable, such as new sponsorships.

Parameters:

Name Type Description Default
login str

The user's login.

required
actions Iterable[SponsorsActivityAction]

Filter activities to only the specified actions.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[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 Optional[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/user.py
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
@task
async def query_user_sponsors_activities(  # noqa
    login: str,
    actions: Iterable[graphql_schema.SponsorsActivityAction],
    github_credentials: GitHubCredentials,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    period: graphql_schema.SponsorsActivityPeriod = "MONTH",
    order_by: graphql_schema.SponsorsActivityOrder = {
        "field": "TIMESTAMP",
        "direction": "DESC",
    },
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Events involving this sponsorable, such as new sponsorships.

    Args:
        login: The user's login.
        actions: Filter activities to only the specified
            actions.
        github_credentials: Credentials to use for authentication with GitHub.
        after: Returns the elements in the list that come
            after the specified cursor.
        before: Returns the elements in the list that come
            before the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        period: Filter activities returned to only those
            that occurred in the most recent specified time period. Set
            to ALL to avoid filtering by when the activity occurred.
        order_by: Ordering options for activity returned
            from the connection.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).sponsors_activities(
        **strip_kwargs(
            actions=actions,
            after=after,
            before=before,
            first=first,
            last=last,
            period=period,
            order_by=order_by,
        )
    )

    op_stack = (
        "user",
        "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["user"]["sponsorsActivities"]

query_user_sponsors_listing(login, github_credentials, return_fields=None) async

The GitHub Sponsors listing for this user or organization.

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
return_fields Optional[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/user.py
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
@task
async def query_user_sponsors_listing(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    The GitHub Sponsors listing for this user or organization.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).sponsors_listing(**strip_kwargs())

    op_stack = (
        "user",
        "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["user"]["sponsorsListing"]

query_user_sponsorship_for_viewer_as_sponsor(login, github_credentials, return_fields=None) 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
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
return_fields Optional[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/user.py
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
@task
async def query_user_sponsorship_for_viewer_as_sponsor(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    return_fields: Optional[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:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).sponsorship_for_viewer_as_sponsor(**strip_kwargs())

    op_stack = (
        "user",
        "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["user"]["sponsorshipForViewerAsSponsor"]

query_user_sponsorship_for_viewer_as_sponsorable(login, github_credentials, return_fields=None) 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
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
return_fields Optional[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/user.py
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
@task
async def query_user_sponsorship_for_viewer_as_sponsorable(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    return_fields: Optional[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:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).sponsorship_for_viewer_as_sponsorable(**strip_kwargs())

    op_stack = (
        "user",
        "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["user"]["sponsorshipForViewerAsSponsorable"]

query_user_sponsorship_newsletters(login, github_credentials, after=None, before=None, first=None, last=None, order_by={'field': 'CREATED_AT', 'direction': 'DESC'}, return_fields=None) async

List of sponsorship updates sent from this sponsorable to sponsors.

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[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 Optional[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/user.py
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
@task
async def query_user_sponsorship_newsletters(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    order_by: graphql_schema.SponsorshipNewsletterOrder = {
        "field": "CREATED_AT",
        "direction": "DESC",
    },
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    List of sponsorship updates sent from this sponsorable to sponsors.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        after: Returns the elements in the list that
            come after the specified cursor.
        before: Returns the elements in the list that
            come before the specified cursor.
        first: Returns the first _n_ elements from the
            list.
        last: Returns the last _n_ elements from the
            list.
        order_by: Ordering options for sponsorship
            updates returned from the connection.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).sponsorship_newsletters(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            order_by=order_by,
        )
    )

    op_stack = (
        "user",
        "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["user"]["sponsorshipNewsletters"]

query_user_sponsorships_as_maintainer(login, github_credentials, after=None, before=None, first=None, last=None, include_private=False, order_by=None, return_fields=None) async

This object's sponsorships as the maintainer.

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[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 Optional[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/user.py
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
@task
async def query_user_sponsorships_as_maintainer(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    include_private: bool = False,
    order_by: graphql_schema.SponsorshipOrder = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    This object's sponsorships as the maintainer.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        after: Returns the elements in the list that
            come after the specified cursor.
        before: Returns the elements in the list that
            come before the specified cursor.
        first: Returns the first _n_ elements from
            the list.
        last: Returns the last _n_ elements from the
            list.
        include_private: Whether or not to include
            private sponsorships in the result set.
        order_by: Ordering options for sponsorships
            returned from this connection. If left blank, the
            sponsorships will be ordered based on relevancy to the
            viewer.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).sponsorships_as_maintainer(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            include_private=include_private,
            order_by=order_by,
        )
    )

    op_stack = (
        "user",
        "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["user"]["sponsorshipsAsMaintainer"]

query_user_sponsorships_as_sponsor(login, github_credentials, after=None, before=None, first=None, last=None, order_by=None, return_fields=None) async

This object's sponsorships as the sponsor.

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[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 Optional[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/user.py
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
@task
async def query_user_sponsorships_as_sponsor(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    order_by: graphql_schema.SponsorshipOrder = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    This object's sponsorships as the sponsor.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        after: Returns the elements in the list that
            come after the specified cursor.
        before: Returns the elements in the list that
            come before the specified cursor.
        first: Returns the first _n_ elements from the
            list.
        last: Returns the last _n_ elements from the
            list.
        order_by: Ordering options for sponsorships
            returned from this connection. If left blank, the
            sponsorships will be ordered based on relevancy to the
            viewer.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).sponsorships_as_sponsor(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            order_by=order_by,
        )
    )

    op_stack = (
        "user",
        "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["user"]["sponsorshipsAsSponsor"]

query_user_starred_repositories(login, github_credentials, after=None, before=None, first=None, last=None, owned_by_viewer=None, order_by=None, return_fields=None) async

Repositories the user has starred.

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
owned_by_viewer Optional[bool]

Filters starred repositories to only return repositories owned by the viewer.

None
order_by StarOrder

Order for connection.

None
return_fields Optional[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/user.py
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
@task
async def query_user_starred_repositories(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    owned_by_viewer: Optional[bool] = None,
    order_by: graphql_schema.StarOrder = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Repositories the user has starred.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        after: Returns the elements in the list that come
            after the specified cursor.
        before: Returns the elements in the list that come
            before the specified cursor.
        first: Returns the first _n_ elements from the
            list.
        last: Returns the last _n_ elements from the list.
        owned_by_viewer: Filters starred repositories to
            only return repositories owned by the viewer.
        order_by: Order for connection.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).starred_repositories(
        **strip_kwargs(
            after=after,
            before=before,
            first=first,
            last=last,
            owned_by_viewer=owned_by_viewer,
            order_by=order_by,
        )
    )

    op_stack = (
        "user",
        "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["user"]["starredRepositories"]

query_user_status(login, github_credentials, return_fields=None) async

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

Parameters:

Name Type Description Default
login str

The user's login.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
return_fields Optional[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/user.py
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
@task
async def query_user_status(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    The user's description of what they're currently doing.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).status(**strip_kwargs())

    op_stack = (
        "user",
        "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["user"]["status"]

query_user_top_repositories(login, order_by, github_credentials, after=None, before=None, first=None, last=None, since=None, return_fields=None) async

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

Parameters:

Name Type Description Default
login str

The user's login.

required
order_by RepositoryOrder

Ordering options for repositories returned from the connection.

required
github_credentials GitHubCredentials

Credentials to use for authentication with GitHub.

required
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
since Optional[datetime]

How far back in time to fetch contributed repositories.

None
return_fields Optional[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/user.py
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
@task
async def query_user_top_repositories(  # noqa
    login: str,
    order_by: graphql_schema.RepositoryOrder,
    github_credentials: GitHubCredentials,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    since: Optional[datetime] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    Repositories the user has contributed to, ordered by contribution rank, plus
    repositories the user has created.

    Args:
        login: The user's login.
        order_by: Ordering options for repositories returned
            from the connection.
        github_credentials: Credentials to use for authentication with GitHub.
        after: Returns the elements in the list that come after
            the specified cursor.
        before: Returns the elements in the list that come
            before the specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        since: How far back in time to fetch contributed
            repositories.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).top_repositories(
        **strip_kwargs(
            order_by=order_by,
            after=after,
            before=before,
            first=first,
            last=last,
            since=since,
        )
    )

    op_stack = (
        "user",
        "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["user"]["topRepositories"]

query_user_watching(login, github_credentials, privacy=None, order_by=None, affiliations=None, owner_affiliations=('OWNER', 'COLLABORATOR'), is_locked=None, after=None, before=None, first=None, last=None, return_fields=None) async

A list of repositories the given user is watching.

Parameters:

Name Type Description Default
login str

The user's login.

required
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 Optional[bool]

If non-null, filters repositories according to whether they have been locked.

None
after Optional[str]

Returns the elements in the list that come after the specified cursor.

None
before Optional[str]

Returns the elements in the list that come before the specified cursor.

None
first Optional[int]

Returns the first n elements from the list.

None
last Optional[int]

Returns the last n elements from the list.

None
return_fields Optional[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/user.py
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
@task
async def query_user_watching(  # noqa
    login: str,
    github_credentials: GitHubCredentials,
    privacy: graphql_schema.RepositoryPrivacy = None,
    order_by: graphql_schema.RepositoryOrder = None,
    affiliations: Iterable[graphql_schema.RepositoryAffiliation] = None,
    owner_affiliations: Iterable[graphql_schema.RepositoryAffiliation] = (
        "OWNER",
        "COLLABORATOR",
    ),
    is_locked: Optional[bool] = None,
    after: Optional[str] = None,
    before: Optional[str] = None,
    first: Optional[int] = None,
    last: Optional[int] = None,
    return_fields: Optional[Iterable[str]] = None,
) -> Dict[str, Any]:  # pragma: no cover
    """
    A list of repositories the given user is watching.

    Args:
        login: The user's login.
        github_credentials: Credentials to use for authentication with GitHub.
        privacy: If non-null, filters repositories according to privacy.
        order_by: Ordering options for repositories returned from the
            connection.
        affiliations: Affiliation options for repositories returned
            from the connection. If none specified, the results will
            include repositories for which the current viewer is an
            owner or collaborator, or member.
        owner_affiliations: Array of owner's affiliation options for
            repositories returned from the connection. For example,
            OWNER will include only repositories that the organization
            or user being viewed owns.
        is_locked: If non-null, filters repositories according to
            whether they have been locked.
        after: Returns the elements in the list that come after the
            specified cursor.
        before: Returns the elements in the list that come before the
            specified cursor.
        first: Returns the first _n_ elements from the list.
        last: Returns the last _n_ elements from the list.
        return_fields: Subset the return fields (as snake_case); defaults to
            fields listed in configs/query/*.json.

    Returns:
        A dict of the returned fields.
    """
    op = Operation(graphql_schema.Query)
    op_selection = op.user(
        **strip_kwargs(
            login=login,
        )
    ).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 = (
        "user",
        "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["user"]["watching"]