feat: Add support for File parameter type

HEXA-1250 Add support for File parameter type

Author: bramj

README.md

@@ -15,23 +15,23 @@ OpenHEXA Python SDK
 
 OpenHEXA is an open-source data integration platform developed by [Bluesquare](https://bluesquarehub.com).
 
-Its goal is to facilitate data integration and analysis workflows, in particular in the context of public health 
+Its goal is to facilitate data integration and analysis workflows, in particular in the context of public health
 projects.
 
 Please refer to the [OpenHEXA wiki](https://github.com/BLSQ/openhexa/wiki/Home) for more information about OpenHEXA.
 
-This repository contains the code of the OpenHEXA SDK, a library allows you to write code for the OpenHEXA platform. 
+This repository contains the code of the OpenHEXA SDK, a library allows you to write code for the OpenHEXA platform.
 It is particularly useful to write OpenHEXA data pipelines, but can also be used in the OpenHEXA notebooks environment.
 
-The OpenHEXA wiki has a section dedicated to the SDK: 
+The OpenHEXA wiki has a section dedicated to the SDK:
 [Using the OpenHEXA SDK](https://github.com/BLSQ/openhexa/wiki/Using-the-OpenHEXA-SDK).
 
 Requirements
 ------------
 
 The OpenHEXA SDK requires Python version 3.11, 3.12 or 3.13.
 
-If you want to be able to run pipeline in a containerized environment on your machine, you will need 
+If you want to be able to run pipeline in a containerized environment on your machine, you will need
 [Docker](https://www.docker.com/).
 
 Quickstart
@@ -52,17 +52,17 @@ You can then install the OpenHEXA SDK:
 pip install --upgrade openhexa.sdk
 ```
 
-💡New OpenHEXA SDK versions are released on a regular basis. Don't forget to update your local installations with 
+💡New OpenHEXA SDK versions are released on a regular basis. Don't forget to update your local installations with
 `pip install --upgrade` from times to times!
 
-Now that the SDK is installed withing your virtual environmentYou can now use the `openhexa` CLI utility to create 
+Now that the SDK is installed withing your virtual environmentYou can now use the `openhexa` CLI utility to create
 a new pipeline:
 
 ```shell
 openhexa pipelines init "My awesome pipeline"
 ```
 
-Great! As you can see in the console output, the OpenHEXA CLI has created a new directory, which contains the basic 
+Great! As you can see in the console output, the OpenHEXA CLI has created a new directory, which contains the basic
 structure required for an OpenHEXA pipeline. You can now `cd` in the new pipeline directory and run the pipeline:
 
 ```shell
@@ -71,7 +71,7 @@ openhexa pipelines run ./my_awesome_pipeline
 
 Congratulations! You have successfully run your first pipeline locally.
 
-If you inspect the actual pipeline code, you will see that it doesn't do a lot of things, but it is still a perfectly 
+If you inspect the actual pipeline code, you will see that it doesn't do a lot of things, but it is still a perfectly
 valid OpenHEXA pipeline.
 
 Let's publish to an actual OpenHEXA workspace so that it can run online.
@@ -89,18 +89,18 @@ You will be prompted for an authentication token, you can find it in the popup a
 After adding the workspace using the CLI, you can now push your pipeline:
 
 ```shell
-openhexa pipelines push 
+openhexa pipelines push
 ```
 
-As it is the first time, the CLI will ask you to confirm the creation operation. After confirmation the console will 
+As it is the first time, the CLI will ask you to confirm the creation operation. After confirmation the console will
 output the link to the pipeline screen in the OpenHEXA interface.
 
 You can now open the link and run the pipeline using the OpenHEXA web interface.
 
 Contributing
 ------------
 
-The following sections explain how you can set up a local development environment if you want to participate to the 
+The following sections explain how you can set up a local development environment if you want to participate to the
 development of the SDK.
 
 ### SDK development setup
@@ -114,8 +114,8 @@ pip install -e ".[dev]"  # Necessary to be able to run the openhexa CLI
 ```
 ### Using a local installation of OpenHEXA to run pipelines
 
-While it is possible to run pipelines locally using only the SDK, if you want to run OpenHEXA in a more realistic 
-setting you will need to install the OpenHEXA app and frontend components. Please refer to the 
+While it is possible to run pipelines locally using only the SDK, if you want to run OpenHEXA in a more realistic
+setting you will need to install the OpenHEXA app and frontend components. Please refer to the
 [installation instructions](https://github.com/BLSQ/openhexa/wiki/Installation-instructions) for more information.
 
 You can then configure the OpenHEXA CLI to connect to your local backend:
@@ -130,7 +130,7 @@ Notes: you can monitor the status of your pipelines using http://localhost:8000/
 
 If you want to use a local version of the SDK to run pipelines, you can build a docker image with the local version of the SDK installed in it :
 
-```shell    
+```shell
 docker build --platform linux/amd64 -t local_image:v1 -f images/Dockerfile .
 ```
 
@@ -165,7 +165,7 @@ We use code generation to create Python client code from our GraphQL schema. Thi
 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
+2. `ariadne-codegen` uses both the schema and queries to generate typed Python client code
 
 To run code generation manually:
 
@@ -191,7 +191,7 @@ 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.
 
 To release a new version:
@@ -200,4 +200,3 @@ To release a new version:
 2. release-please will create a new release PR on GitHub.
 3. Once the PR is merged, release-please will create a new release on GitHub.
 4. A GitHub action will build the package on github release creation and upload it to PyPI and Anaconda.
-

openhexa/graphql/graphql_client/__init__.py

@@ -87,6 +87,7 @@
     AccessmodFilesetRoleCode,
     AccessmodFilesetStatus,
     AccessmodProjectOrder,
+    AddOrganizationMemberError,
     AddToFavoritesError,
     ApproveAccessmodAccessRequestError,
     ArchiveWorkspaceError,
@@ -125,6 +126,8 @@
     DeleteDatasetVersionError,
     DeleteMembershipError,
     DeleteMetadataAttributeError,
+    DeleteOrganizationInvitationError,
+    DeleteOrganizationMemberError,
     DeletePipelineVersionError,
     DeleteTeamError,
     DeleteTemplateVersionError,
@@ -147,6 +150,7 @@
     GenerateWorkspaceTokenError,
     IASOConnectionError,
     IASOMetadataType,
+    InviteOrganizationMemberError,
     InviteWorkspaceMembershipError,
     JoinWorkspaceError,
     LaunchAccessmodAnalysisError,
@@ -156,6 +160,8 @@
     MembershipRole,
     MessagePriority,
     OrderByDirection,
+    OrganizationInvitationStatus,
+    OrganizationMembershipRole,
     ParameterType,
     ParameterWidget,
     PermissionMode,
@@ -174,6 +180,7 @@
     RegisterError,
     RemoveFromFavoritesError,
     RequestAccessmodAccessError,
+    ResendOrganizationInvitationError,
     ResendWorkspaceInvitationError,
     RunDAGError,
     SetDAGRunFavoriteError,
@@ -189,6 +196,7 @@
     UpdateDatasetError,
     UpdateDatasetVersionError,
     UpdateMembershipError,
+    UpdateOrganizationMemberError,
     UpdatePipelineError,
     UpdatePipelineVersionError,
     UpdateTeamError,
@@ -215,8 +223,10 @@
     GetConnectionConnectionBySlug,
     GetConnectionConnectionBySlugFields,
 )
+from .get_file_by_path import GetFileByPath, GetFileByPathGetFileByPath
 from .get_users import GetUsers, GetUsersUsers, GetUsersUsersAvatar
 from .input_types import (
+    AddOrganizationMemberInput,
     AddPipelineOutputInput,
     AddToFavoritesInput,
     ApproveAccessmodAccessRequestInput,
@@ -254,6 +264,8 @@
     DeleteDatasetVersionInput,
     DeleteMembershipInput,
     DeleteMetadataAttributeInput,
+    DeleteOrganizationInvitationInput,
+    DeleteOrganizationMemberInput,
     DeletePipelineInput,
     DeletePipelineRecipientInput,
     DeletePipelineTemplateInput,
@@ -273,6 +285,7 @@
     GeneratePipelineWebhookUrlInput,
     GenerateWorkspaceTokenInput,
     IASOQueryFilterInput,
+    InviteOrganizationMemberInput,
     InviteWorkspaceMemberInput,
     JoinWorkspaceInput,
     LaunchAccessmodAnalysisInput,
@@ -294,6 +307,7 @@
     RegisterInput,
     RemoveFromFavoritesInput,
     RequestAccessmodAccessInput,
+    ResendOrganizationInvitationInput,
     ResendWorkspaceInvitationInput,
     ResetPasswordInput,
     RunDAGInput,
@@ -312,6 +326,7 @@
     UpdateDatasetInput,
     UpdateDatasetVersionInput,
     UpdateMembershipInput,
+    UpdateOrganizationMemberInput,
     UpdatePipelineInput,
     UpdatePipelineProgressInput,
     UpdatePipelineRecipientInput,
@@ -326,6 +341,8 @@
     UpgradePipelineVersionFromTemplateInput,
     UploadPipelineInput,
     VerifyDeviceInput,
+    WorkspaceInvitationInput,
+    WorkspacePermissionInput,
 )
 from .invite_workspace_member import (
     InviteWorkspaceMember,
@@ -405,6 +422,8 @@
     "AccessmodFilesetRoleCode",
     "AccessmodFilesetStatus",
     "AccessmodProjectOrder",
+    "AddOrganizationMemberError",
+    "AddOrganizationMemberInput",
     "AddPipelineOutputInput",
     "AddPipelineRecipient",
     "AddPipelineRecipientAddPipelineRecipient",
@@ -531,6 +550,10 @@
     "DeleteMembershipInput",
     "DeleteMetadataAttributeError",
     "DeleteMetadataAttributeInput",
+    "DeleteOrganizationInvitationError",
+    "DeleteOrganizationInvitationInput",
+    "DeleteOrganizationMemberError",
+    "DeleteOrganizationMemberInput",
     "DeletePipeline",
     "DeletePipelineDeletePipeline",
     "DeletePipelineInput",
@@ -577,6 +600,8 @@
     "GetConnection",
     "GetConnectionConnectionBySlug",
     "GetConnectionConnectionBySlugFields",
+    "GetFileByPath",
+    "GetFileByPathGetFileByPath",
     "GetUsers",
     "GetUsersUsers",
     "GetUsersUsersAvatar",
@@ -588,6 +613,8 @@
     "IASOConnectionError",
     "IASOMetadataType",
     "IASOQueryFilterInput",
+    "InviteOrganizationMemberError",
+    "InviteOrganizationMemberInput",
     "InviteWorkspaceMember",
     "InviteWorkspaceMemberInput",
     "InviteWorkspaceMemberInviteWorkspaceMember",
@@ -608,6 +635,8 @@
     "MessagePriority",
     "OrderByDirection",
     "OrganizationInput",
+    "OrganizationInvitationStatus",
+    "OrganizationMembershipRole",
     "ParameterInput",
     "ParameterType",
     "ParameterWidget",
@@ -659,6 +688,8 @@
     "RemoveWebappFromFavoritesRemoveFromFavorites",
     "RequestAccessmodAccessError",
     "RequestAccessmodAccessInput",
+    "ResendOrganizationInvitationError",
+    "ResendOrganizationInvitationInput",
     "ResendWorkspaceInvitationError",
     "ResendWorkspaceInvitationInput",
     "ResetPasswordInput",
@@ -701,6 +732,8 @@
     "UpdateDatasetVersionInput",
     "UpdateMembershipError",
     "UpdateMembershipInput",
+    "UpdateOrganizationMemberError",
+    "UpdateOrganizationMemberInput",
     "UpdatePipelineError",
     "UpdatePipelineInput",
     "UpdatePipelineProgressInput",
@@ -738,8 +771,10 @@
     "VerifyDeviceError",
     "VerifyDeviceInput",
     "Workspace",
+    "WorkspaceInvitationInput",
     "WorkspaceInvitationStatus",
     "WorkspaceMembershipRole",
+    "WorkspacePermissionInput",
     "WorkspaceWorkspace",
     "WorkspaceWorkspaceCountries",
     "WorkspaceWorkspacePermissions",

openhexa/graphql/graphql_client/client.py

@@ -42,6 +42,7 @@
 )
 from .delete_webapp import DeleteWebapp, DeleteWebappDeleteWebapp
 from .get_connection import GetConnection, GetConnectionConnectionBySlug
+from .get_file_by_path import GetFileByPath, GetFileByPathGetFileByPath
 from .get_users import GetUsers, GetUsersUsers
 from .input_types import (
     AddToFavoritesInput,
@@ -1042,3 +1043,26 @@ def get_connection(
         )
         data = self.get_data(response)
         return GetConnection.model_validate(data).connection_by_slug
+
+    def get_file_by_path(
+        self, path: str, workspace_slug: str, **kwargs: Any
+    ) -> Optional[GetFileByPathGetFileByPath]:
+        query = gql(
+            """
+            query getFileByPath($path: String!, $workspaceSlug: String!) {
+              getFileByPath(workspaceSlug: $workspaceSlug, path: $path) {
+                key
+                name
+                path
+                size
+                type
+              }
+            }
+            """
+        )
+        variables: Dict[str, object] = {"path": path, "workspaceSlug": workspace_slug}
+        response = self.execute(
+            query=query, operation_name="getFileByPath", variables=variables, **kwargs
+        )
+        data = self.get_data(response)
+        return GetFileByPath.model_validate(data).get_file_by_path