fragment-python 0.1.1__tar.gz → 0.2.0__tar.gz

{fragment_python-0.1.1 → fragment_python-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fragment-python
-Version: 0.1.1
+Version: 0.2.0
 Summary: Python SDK for https://fragment.dev/
 License: Apache 2.0
 Author: Fragment Foundries Inc
@@ -63,6 +63,26 @@ loop.run_until_complete(print_schema())
 
 Read the [Using custom queries](#using-custom-queries) section to learn how to use your own GraphQL queries with the SDK.
 
+### Using a synchronous client
+
+If you prefer using a synchronous client instead of an async one, then:
+
+```python
+from fragment.sync_sdk.client import Client
+
+graphql_client = Client(
+    client_id="<client id from the dashboard>",
+    client_secret="<client secret from the dashboard>",
+    api_url="<api url from the dashboard>",
+    auth_url="<auth url from the dashboard>",
+    auth_scope="<auth scope from the dashboard>",
+  )
+
+get_schema_result = graphql_client.get_schema("<Your schema key here>")
+print(get_schema_result.schema_.json())
+
+```
+
 ## Examples
 
 ### Post a Ledger Entry
@@ -110,7 +130,7 @@ query getSchemaName($key: SafeString!) {
   }
 }
 ```
-2. Run `fragment-python-client-codegen` to generate the GraphQL SDK client. GraphQL named queries are converted to snake_case to conform to Python's code conventions.
+2. Run `fragment-python-client-codegen` to generate the GraphQL SDK client. GraphQL named queries are converted to snake_case to conform to Python's code conventions. Optionally, pass the `--sync` flag to generate a synchronous client instead of the default async GraphQL client.
 ```bash
 fragment-python-client-codegen \
   --input-dir queries/ \
@@ -132,7 +152,7 @@ graphql_client = Client(
 
 async def print_schema_name():
   # Note that getSchemaName is converted to snake_case automatically
-  response = await graphql_client.get_schema_name()
+  response = await graphql_client.get_schema_name("<Your Schema Key>")
   print(response.schema_.key)
 
 import asyncio

{fragment_python-0.1.1 → fragment_python-0.2.0}/README.md

@@ -42,6 +42,26 @@ loop.run_until_complete(print_schema())
 
 Read the [Using custom queries](#using-custom-queries) section to learn how to use your own GraphQL queries with the SDK.
 
+### Using a synchronous client
+
+If you prefer using a synchronous client instead of an async one, then:
+
+```python
+from fragment.sync_sdk.client import Client
+
+graphql_client = Client(
+    client_id="<client id from the dashboard>",
+    client_secret="<client secret from the dashboard>",
+    api_url="<api url from the dashboard>",
+    auth_url="<auth url from the dashboard>",
+    auth_scope="<auth scope from the dashboard>",
+  )
+
+get_schema_result = graphql_client.get_schema("<Your schema key here>")
+print(get_schema_result.schema_.json())
+
+```
+
 ## Examples
 
 ### Post a Ledger Entry
@@ -89,7 +109,7 @@ query getSchemaName($key: SafeString!) {
   }
 }
 ```
-2. Run `fragment-python-client-codegen` to generate the GraphQL SDK client. GraphQL named queries are converted to snake_case to conform to Python's code conventions.
+2. Run `fragment-python-client-codegen` to generate the GraphQL SDK client. GraphQL named queries are converted to snake_case to conform to Python's code conventions. Optionally, pass the `--sync` flag to generate a synchronous client instead of the default async GraphQL client.
 ```bash
 fragment-python-client-codegen \
   --input-dir queries/ \
@@ -111,7 +131,7 @@ graphql_client = Client(
 
 async def print_schema_name():
   # Note that getSchemaName is converted to snake_case automatically
-  response = await graphql_client.get_schema_name()
+  response = await graphql_client.get_schema_name("<Your Schema Key>")
   print(response.schema_.key)
 
 import asyncio

fragment_python-0.2.0/fragment/client/sync_client.py

@@ -0,0 +1,67 @@
+# Ignore untyped authlib
+# mypy: disable-error-code="import-untyped"
+import time
+from typing import Any, Dict, Optional
+
+import httpx
+from ariadne_codegen.client_generators.dependencies.base_client import (
+    BaseClient,
+)
+from authlib.integrations.httpx_client import OAuth2Client
+
+from fragment.exceptions import MissingArgumentException, MissingTokenException
+
+
+class SyncFragmentClient(BaseClient):
+    def __init__(
+        self,
+        api_url: str = "",
+        auth_url: str = "",
+        auth_scope: str = "",
+        client_id: str = "",
+        client_secret: str = "",
+        http_client: Optional[httpx.AsyncClient] = None,
+    ):
+        if api_url == "":
+            raise MissingArgumentException("api_url")
+        if auth_url == "":
+            raise MissingArgumentException("auth_url")
+        if auth_scope == "":
+            raise MissingArgumentException("auth_scope")
+        if client_id == "":
+            raise MissingArgumentException("client_id")
+        if client_secret == "":
+            raise MissingArgumentException("client_secret")
+        super().__init__(url=api_url, http_client=http_client)
+
+        self.auth_url = auth_url
+        self.expiration_time = None
+        self.token = None
+        self.oauth2_client = OAuth2Client(
+            client_id, client_secret, scope=auth_scope
+        )
+
+    def refresh_token(self):
+        now = time.time()
+        if self.expiration_time is None or self.expiration_time <= now:
+            self.token = self.oauth2_client.fetch_token(self.auth_url)
+            self.expiration_time = now + self.token["expires_in"]
+
+    def execute(
+        self,
+        query: str,
+        operation_name: Optional[str] = None,
+        variables: Optional[Dict[str, Any]] = None,
+        **kwargs: Any,
+    ) -> httpx.Response:
+        self.refresh_token()
+        if self.token is None:
+            raise MissingTokenException()
+        headers = kwargs.get("headers", {})
+        kwargs.update(
+            headers={
+                "Authorization": f'Bearer {self.token["access_token"]}',
+                **headers,
+            }
+        )
+        return super().execute(query, operation_name, variables, **kwargs)

{fragment_python-0.1.1 → fragment_python-0.2.0}/fragment/codegen/helpers.py

@@ -18,9 +18,15 @@ def get_codegen_config(
     schema_path: str,
     queries_path: str,
     target_package_name: str,
-    target_package_path: Optional[str] = None
+    target_package_path: Optional[str] = None,
+    use_sync_client: bool = False,
 ) -> Dict:
     """Get the configuration for the codegen tool."""
+    client_name, file_path = (
+        ("AsyncFragmentClient", "../../client/async_client.py")
+        if not use_sync_client
+        else ("SyncFragmentClient", "../../client/sync_client.py")
+    )
     return dict(
         tool={
             "ariadne-codegen": dict(
@@ -30,10 +36,9 @@ def get_codegen_config(
                 target_package_path=(
                     target_package_path if target_package_path else Path.cwd()
                 ),
-                base_client_name="AsyncFragmentClient",
-                base_client_file_path=get_project_path_relative_to_file(
-                    "../../client/async_client.py"
-                ),
+                base_client_name=client_name,
+                base_client_file_path=get_project_path_relative_to_file(file_path),
+                async_client=False if use_sync_client else True,
                 plugins=[
                     "fragment.codegen.plugins.get_file_comment.GenerateFileComment",
                     "fragment.codegen.plugins.generate_client_method.RewriteUnsetTypeMethodArguments",

{fragment_python-0.1.1 → fragment_python-0.2.0}/fragment/codegen/main.py

@@ -37,7 +37,13 @@ GRAPHQL_SCHEMA_API_URL = "https://api.us-west-2.fragment.dev/schema.graphql"
     help="The output directory for the generated SDK. Defaults to CWD.",
     required=False,
 )
-def run(input_dir, target_package_name, output_dir=None):
+@click.option(
+    "--sync",
+    help="Generate a synchronous client. Defaults to async.",
+    required=False,
+    is_flag=True,
+)
+def run(input_dir, target_package_name, sync, output_dir=None):
     console_log.info(f"Downloading the GraphQL schema from {GRAPHQL_SCHEMA_API_URL}")
     try:
         r = httpx.get(GRAPHQL_SCHEMA_API_URL)
@@ -53,6 +59,7 @@ def run(input_dir, target_package_name, output_dir=None):
             standard_query_file.write(get_standard_queries())
             standard_query_file.flush()
             config_dict = get_codegen_config(
+                use_sync_client=sync,
                 schema_path=schema_file.name,
                 queries_path=input_dir,
                 target_package_name=target_package_name,