fix: refactor OpenHexaClient to allow usage in both CLI and SDK without circular dependency (HEXA-1314) (#279)

Author: yolanfery

README.md

@@ -148,6 +148,40 @@ You can run the tests using pytest:
 pytest
 ```
 
+### Codegen from the GraphQL schema
+
+We use code generation to create Python client code from our GraphQL schema. This involves one tools:
+
+- [**ariadne-codegen**](https://github.com/mirumee/ariadne-codegen): Generates typed Python GraphQL client code from GraphQL files
+
+The code generation process:
+
+1. The GraphQL schema is manually taken from the [Openhexa Monorepo](https://github.com/BLSQ/openhexa-app/blob/main/frontend/schema.generated.graphql) and saved in [`openhexa/graphql/schema.generated.graphql`](https://github.com/BLSQ/openhexa-sdk-python/blob/main/openhexa/graphql/schema.generated.graphql)
+2`ariadne-codegen` uses both the schema and queries to generate typed Python client code
+
+To run code generation manually:
+
+```shell
+pip install ariadne-codegen
+ariadne-codegen
+```
+
+ariadne-codegen runs automatically via pre-commit hooks and CI/CD when GraphQL files are modified.
+
+You can add new queries or mutations in the [`openhexa/graphql/queries.graphql`](https://github.com/BLSQ/openhexa-sdk-python/blob/main/openhexa/graphql/queries.graphql) directory, and they will be picked up by the code generation process.
+
+Example of usage of the generated code:
+
+```python
+from sdk import OpenHexaClient
+
+# connect to OpenHEXA backend using environment variables
+OpenHexaClient().get_countries(workspace_slug="workspace_slug_example")
+
+# or explicitly pass the URL and token
+OpenHexaClient(server_url="app.demo.openhexa.org", token="supersecuretoken")
+ ```
+
 ## Release
 
 This project uses [release-please](https://github.com/googleapis/release-please) to manage releases using conventional commits.

openhexa/cli/api.py

@@ -21,8 +21,8 @@
 from graphql.utilities import find_breaking_changes
 from jinja2 import Template
 
-from openhexa.cli.graphql.graphql_client import Client
 from openhexa.cli.settings import settings
+from openhexa.graphql import BaseOpenHexaClient
 from openhexa.sdk.pipelines import get_local_workspace_config
 from openhexa.sdk.pipelines.runtime import get_pipeline
 from openhexa.utils import create_requests_session, stringcase
@@ -747,31 +747,16 @@ def is_dhis2_connection_up(workspace_slug: str, connection_slug: str) -> bool:
     return response["data"]["connectionBySlug"]["status"] == "UP"
 
 
-class OpenHexaClient(Client):
+class OpenHexaClient(BaseOpenHexaClient):
     """OpenHexaClient is a class that provides methods to interact with the OpenHexa GraphQL API."""
 
     def __init__(self, token=None):
         """Initialize the OpenHexaClient with the OpenHexa API URL and headers."""
-        self._url = settings.api_url + "/graphql/"
-        self._token = token or settings.access_token
-
-        if not self._token:
-            raise InvalidTokenError("No token found for workspace")
-
-        super().__init__(
-            url=self._url,
-            headers={
-                "User-Agent": f"openhexa-cli/{version('openhexa.sdk')}",
-                "Authorization": f"Bearer {self._token}",
-            },
-        )
-        logging.getLogger("httpx").setLevel(
-            logging.WARNING
-        )  # HTTPX logs queries by default, we disable them here with WARNING level
+        super().__init__(url=settings.api_url + "/graphql/", token=settings.access_token)
 
     def execute(self, query, **kwargs):
         """Decorate parent execute method to log the GraphQL query and response."""
-        _detect_graphql_breaking_changes(token=self._token)
+        _detect_graphql_breaking_changes(token=self.token)
 
         if settings.debug:
             click.echo("")

openhexa/graphql/__init__.py

@@ -0,0 +1,5 @@
+"""GraphQL package."""
+
+
+from .base_openhexa_client import BaseOpenHexaClient  # noqa: F401 -> Expose base client class
+from .graphql_client import *  # noqa: F403 -> Expose autogenerated types

openhexa/graphql/base_openhexa_client.py

@@ -0,0 +1,29 @@
+"""OpenHexaClient implementation for GraphQL API interaction."""
+
+import logging
+from importlib.metadata import version
+
+from openhexa.graphql.graphql_client import Client
+
+
+class BaseOpenHexaClient(Client):
+    """OpenHexaClient is a class that provides methods to interact with the OpenHexa GraphQL API."""
+
+    def __init__(self, url: str, token: str):
+        """Initialize the OpenHexaClient with the OpenHexa API URL and headers.
+
+        Args:
+            url: GraphQL API URL.
+            token: Authentication token.
+        """
+        self.token = token
+        super().__init__(
+            url=url,
+            headers={
+                "User-Agent": f"openhexa-sdk/{version('openhexa.sdk')}",
+                "Authorization": f"Bearer {self.token}",
+            },
+        )
+        logging.getLogger("httpx").setLevel(
+            logging.WARNING
+        )  # HTTPX logs queries by default, we disable them here with WARNING level

…a/cli/graphql/graphql_client/__init__.py …nhexa/graphql/graphql_client/__init__.pyopenhexa/cli/graphql/graphql_client/__init__.py renamed to openhexa/graphql/graphql_client/__init__.py openhexa/cli/graphql/graphql_client/__init__.py renamed to openhexa/graphql/graphql_client/__init__.py

@@ -1,5 +1,5 @@
 # Generated by ariadne-codegen
-# Source: openhexa/cli/graphql/queries.graphql
+# Source: openhexa/graphql/queries.graphql
 
 from typing import Any, Dict, Optional, Union
 

…phql/graphql_client/async_base_client.py …phql/graphql_client/async_base_client.pyopenhexa/cli/graphql/graphql_client/async_base_client.py renamed to openhexa/graphql/graphql_client/async_base_client.py openhexa/cli/graphql/graphql_client/async_base_client.py renamed to openhexa/graphql/graphql_client/async_base_client.py

@@ -1,5 +1,5 @@
 # Generated by ariadne-codegen
-# Source: openhexa/cli/graphql/schema.generated.graphql
+# Source: openhexa/graphql/schema.generated.graphql
 
 from enum import Enum