prefect-github 0.2.7__tar.gz → 0.3.0__tar.gz

{prefect_github-0.2.7/prefect_github.egg-info → prefect_github-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: prefect-github
-Version: 0.2.7
+Version: 0.3.0
 Summary: Prefect integrations interacting with GitHub
 Author-email: "Prefect Technologies, Inc." <help@prefect.io>
 License: Apache License 2.0
@@ -11,17 +11,16 @@ Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: sgqlc>=15.0
-Requires-Dist: prefect<3.0.0,>=2.20.0
+Requires-Dist: prefect>=3.0.0rc1
 Provides-Extra: dev
 Requires-Dist: coverage; extra == "dev"
 Requires-Dist: interrogate; extra == "dev"
@@ -29,16 +28,16 @@ Requires-Dist: mkdocs-gen-files; extra == "dev"
 Requires-Dist: mkdocs-material; extra == "dev"
 Requires-Dist: mkdocs; extra == "dev"
 Requires-Dist: mkdocstrings[python]; extra == "dev"
-Requires-Dist: mock; python_version < "3.8" and extra == "dev"
 Requires-Dist: mypy; extra == "dev"
 Requires-Dist: pillow; extra == "dev"
 Requires-Dist: pre-commit; extra == "dev"
 Requires-Dist: pytest-asyncio; extra == "dev"
 Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-env; extra == "dev"
 Requires-Dist: pytest-xdist; extra == "dev"
 
 # prefect-github
- 
+
 <p align="center">
     <a href="https://pypi.python.org/pypi/prefect-github/" alt="PyPI version">
         <img alt="PyPI" src="https://img.shields.io/pypi/v/prefect-github?color=26272B&labelColor=090422"></a>
@@ -56,7 +55,7 @@ The tasks within this collection were created by a code generator using the GitH
 
 ### Python setup
 
-Requires an installation of Python 3.8 or newer.
+Requires an installation of Python 3.9 or newer.
 
 We recommend using a Python virtual environment manager such as pipenv, conda or virtualenv.
 

{prefect_github-0.2.7 → prefect_github-0.3.0}/README.md

@@ -1,5 +1,5 @@
 # prefect-github
- 
+
 <p align="center">
     <a href="https://pypi.python.org/pypi/prefect-github/" alt="PyPI version">
         <img alt="PyPI" src="https://img.shields.io/pypi/v/prefect-github?color=26272B&labelColor=090422"></a>
@@ -17,7 +17,7 @@ The tasks within this collection were created by a code generator using the GitH
 
 ### Python setup
 
-Requires an installation of Python 3.8 or newer.
+Requires an installation of Python 3.9 or newer.
 
 We recommend using a Python virtual environment manager such as pipenv, conda or virtualenv.
 

prefect_github-0.3.0/prefect_github/__init__.py

@@ -0,0 +1,8 @@
+# pyright: reportPrivateUsage=false
+from . import _version
+from .credentials import GitHubCredentials  # noqa
+from .repository import GitHubRepository  # noqa
+
+__all__ = ["GitHubCredentials", "GitHubRepository"]
+
+__version__ = getattr(_version, "__version__")

{prefect_github-0.2.7 → prefect_github-0.3.0}/prefect_github/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.2.7'
-__version_tuple__ = version_tuple = (0, 2, 7)
+__version__ = version = '0.3.0'
+__version_tuple__ = version_tuple = (0, 3, 0)

{prefect_github-0.2.7 → prefect_github-0.3.0}/prefect_github/credentials.py

@@ -1,18 +1,12 @@
 """Credential classes used to perform authenticated interactions with GitHub"""
 
-import warnings
+from typing import Optional
 
-from pydantic import VERSION as PYDANTIC_VERSION
+from pydantic import Field, SecretStr
+from sgqlc.endpoint.http import HTTPEndpoint
 
 from prefect.blocks.abstract import CredentialsBlock
 
-if PYDANTIC_VERSION.startswith("2."):
-    from pydantic.v1 import Field, SecretStr
-else:
-    from pydantic import Field, SecretStr
-
-from sgqlc.endpoint.http import HTTPEndpoint
-
 
 class GitHubCredentials(CredentialsBlock):
     """
@@ -33,7 +27,7 @@ class GitHubCredentials(CredentialsBlock):
     _logo_url = "https://cdn.sanity.io/images/3ugk85nk/production/41971cfecfea5f79ff334164f06ecb34d1038dd4-250x250.png"  # noqa
     _documentation_url = "https://prefecthq.github.io/prefect-github/credentials/#prefect_github.credentials.GitHubCredentials"  # noqa
 
-    token: SecretStr = Field(
+    token: Optional[SecretStr] = Field(
         default=None, description="A GitHub personal access token (PAT)."
     )
 
@@ -63,33 +57,3 @@ class GitHubCredentials(CredentialsBlock):
             "https://api.github.com/graphql", base_headers=base_headers
         )
         return endpoint
-
-    def get_endpoint(self) -> HTTPEndpoint:
-        """
-        Gets an authenticated GitHub GraphQL HTTPEndpoint.
-
-        Returns:
-            An authenticated GitHub GraphQL HTTPEndpoint
-
-        Example:
-            Gets an authenticated GitHub GraphQL HTTPEndpoint.
-            ```python
-            from prefect import flow
-            from prefect_github import GitHubCredentials
-
-            @flow
-            def example_get_endpoint_flow():
-                token = "token_xxxxxxx"
-                github_credentials = GitHubCredentials(token=token)
-                endpoint = github_credentials.get_endpoint()
-                return endpoint
-
-            example_get_endpoint_flow()
-            ```
-        """
-        warnings.warn(
-            "`get_endpoint` is deprecated and will be removed March 31st, 2023, "
-            "use `get_client` instead.",
-            DeprecationWarning,
-        )
-        return self.get_client()

{prefect_github-0.2.7 → prefect_github-0.3.0}/prefect_github/graphql.py

@@ -13,6 +13,7 @@ from anyio import to_thread
 from sgqlc.operation import Operation, Selection
 
 from prefect import task
+from prefect.utilities.asyncutils import sync_compatible
 from prefect_github import GitHubCredentials
 from prefect_github.utils import camel_to_snake_case
 
@@ -61,6 +62,7 @@ def _subset_return_fields(
 
 
 @task
+@sync_compatible
 async def execute_graphql(
     op: Union[Operation, str],
     github_credentials: GitHubCredentials,

{prefect_github-0.2.7 → prefect_github-0.3.0}/prefect_github/mutations.py

@@ -10,7 +10,7 @@ GitHub mutation tasks
 
 from datetime import datetime
 from pathlib import Path
-from typing import Any, Dict, Iterable
+from typing import Any, Dict, Iterable, Optional
 
 from sgqlc.operation import Operation
 
@@ -31,7 +31,7 @@ async def add_comment_subject(  # noqa
     subject_id: str,
     body: str,
     github_credentials: GitHubCredentials,
-    return_fields: Iterable[str] = None,
+    return_fields: Optional[Iterable[str]] = None,
 ) -> Dict[str, Any]:  # pragma: no cover
     """
     Adds a comment to an Issue or Pull Request.
@@ -75,10 +75,10 @@ async def create_pull_request(  # noqa
     head_ref_name: str,
     title: str,
     github_credentials: GitHubCredentials,
-    body: str = None,
-    maintainer_can_modify: bool = None,
-    draft: bool = None,
-    return_fields: Iterable[str] = None,
+    body: Optional[str] = None,
+    maintainer_can_modify: Optional[bool] = None,
+    draft: Optional[bool] = None,
+    return_fields: Optional[Iterable[str]] = None,
 ) -> Dict[str, Any]:  # pragma: no cover
     """
     Create a new pull request.
@@ -136,7 +136,7 @@ async def create_pull_request(  # noqa
 async def close_pull_request(  # noqa
     pull_request_id: str,
     github_credentials: GitHubCredentials,
-    return_fields: Iterable[str] = None,
+    return_fields: Optional[Iterable[str]] = None,
 ) -> Dict[str, Any]:  # pragma: no cover
     """
     Close a pull request.
@@ -179,10 +179,10 @@ async def create_issue(  # noqa
     label_ids: Iterable[str],
     project_ids: Iterable[str],
     github_credentials: GitHubCredentials,
-    body: str = None,
-    milestone_id: str = None,
-    issue_template: str = None,
-    return_fields: Iterable[str] = None,
+    body: Optional[str] = None,
+    milestone_id: Optional[str] = None,
+    issue_template: Optional[str] = None,
+    return_fields: Optional[Iterable[str]] = None,
 ) -> Dict[str, Any]:  # pragma: no cover
     """
     Creates a new issue.
@@ -238,7 +238,7 @@ async def close_issue(  # noqa
     issue_id: str,
     github_credentials: GitHubCredentials,
     state_reason: graphql_schema.IssueClosedStateReason = None,
-    return_fields: Iterable[str] = None,
+    return_fields: Optional[Iterable[str]] = None,
 ) -> Dict[str, Any]:  # pragma: no cover
     """
     Close an issue.
@@ -279,7 +279,7 @@ async def close_issue(  # noqa
 async def add_star_starrable(  # noqa
     starrable_id: str,
     github_credentials: GitHubCredentials,
-    return_fields: Iterable[str] = None,
+    return_fields: Optional[Iterable[str]] = None,
 ) -> Dict[str, Any]:  # pragma: no cover
     """
     Adds a star to a Starrable.
@@ -318,7 +318,7 @@ async def add_star_starrable(  # noqa
 async def remove_star_starrable(  # noqa
     starrable_id: str,
     github_credentials: GitHubCredentials,
-    return_fields: Iterable[str] = None,
+    return_fields: Optional[Iterable[str]] = None,
 ) -> Dict[str, Any]:  # pragma: no cover
     """
     Removes a star from a Starrable.
@@ -358,7 +358,7 @@ async def add_reaction_subject(  # noqa
     subject_id: str,
     content: graphql_schema.ReactionContent,
     github_credentials: GitHubCredentials,
-    return_fields: Iterable[str] = None,
+    return_fields: Optional[Iterable[str]] = None,
 ) -> Dict[str, Any]:  # pragma: no cover
     """
     Adds a reaction to a subject.
@@ -400,7 +400,7 @@ async def add_reaction(  # noqa
     subject_id: str,
     content: graphql_schema.ReactionContent,
     github_credentials: GitHubCredentials,
-    return_fields: Iterable[str] = None,
+    return_fields: Optional[Iterable[str]] = None,
 ) -> Dict[str, Any]:  # pragma: no cover
     """
     Adds a reaction to a subject.
@@ -442,7 +442,7 @@ async def remove_reaction_subject(  # noqa
     subject_id: str,
     content: graphql_schema.ReactionContent,
     github_credentials: GitHubCredentials,
-    return_fields: Iterable[str] = None,
+    return_fields: Optional[Iterable[str]] = None,
 ) -> Dict[str, Any]:  # pragma: no cover
     """
     Removes a reaction from a subject.
@@ -484,7 +484,7 @@ async def remove_reaction(  # noqa
     subject_id: str,
     content: graphql_schema.ReactionContent,
     github_credentials: GitHubCredentials,
-    return_fields: Iterable[str] = None,
+    return_fields: Optional[Iterable[str]] = None,
 ) -> Dict[str, Any]:  # pragma: no cover
     """
     Removes a reaction from a subject.
@@ -527,8 +527,8 @@ async def request_reviews(  # noqa
     user_ids: Iterable[str],
     team_ids: Iterable[str],
     github_credentials: GitHubCredentials,
-    union: bool = None,
-    return_fields: Iterable[str] = None,
+    union: Optional[bool] = None,
+    return_fields: Optional[Iterable[str]] = None,
 ) -> Dict[str, Any]:  # pragma: no cover
     """
     Set review requests on a pull request.
@@ -572,8 +572,8 @@ async def request_reviews_pull_request(  # noqa
     user_ids: Iterable[str],
     team_ids: Iterable[str],
     github_credentials: GitHubCredentials,
-    union: bool = None,
-    return_fields: Iterable[str] = None,
+    union: Optional[bool] = None,
+    return_fields: Optional[Iterable[str]] = None,
 ) -> Dict[str, Any]:  # pragma: no cover
     """
     Set review requests on a pull request.
@@ -618,12 +618,12 @@ async def request_reviews_pull_request(  # noqa
 async def add_pull_request_review(  # noqa
     pull_request_id: str,
     github_credentials: GitHubCredentials,
-    commit_oid: datetime = None,
-    body: str = None,
+    commit_oid: Optional[datetime] = None,
+    body: Optional[str] = None,
     event: graphql_schema.PullRequestReviewEvent = None,
     comments: Iterable[graphql_schema.DraftPullRequestReviewComment] = None,
     threads: Iterable[graphql_schema.DraftPullRequestReviewThread] = None,
-    return_fields: Iterable[str] = None,
+    return_fields: Optional[Iterable[str]] = None,
 ) -> Dict[str, Any]:  # pragma: no cover
     """
     Adds a review to a Pull Request.