perceptic-core-client 0.7.1__tar.gz → 0.7.2__tar.gz

{perceptic_core_client-0.7.1 → perceptic_core_client-0.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: perceptic-core-client
-Version: 0.7.1
+Version: 0.7.2
 Summary: Python client for Perceptic Core
 Author-email: Your Name <you@example.com>
 License: Proprietary
@@ -25,7 +25,7 @@ This package provides a generated Python client for interacting with the Percept
 
 ## Installation
 
-Install the package from the configured package registry (ensure `pip` is configured, see parent project documentation if using GitHub Packages):
+Install the package from the configured package registry (ensure `pip` is configured):
 
 ```bash
 pip install perceptic-core-client
@@ -34,6 +34,18 @@ pip install perceptic-core-client
 # pip install perceptic-core-client==<version>
 ```
 
+### Development
+
+`pip install -e .[dev]`
+
+This package gets automatically published to pip when a new version is tagged in the repository. The workflow file for this is located at `.github/workflows/publish-python.yml`. It will publish the same version as the one tagged in the repository.
+
+To generate the client code locally for testing o development, you can run:
+```bash
+python perceptic-core-python-client/scripts/generate_client.py --spec-path perceptic-core-server/openapi/openapi.json --version 0.5.0
+```
+Note that the `--version` doesn't really matter if generating locally and not publishing to pypi. It's only relevant if publishing the package to pypi, which is done automatically by the GitHub action.
+
 ## Basic Usage
 You need the URL of your Perceptic Core API instance and a valid authentication token (e.g., a Bearer token from Keycloak) obtained separately.
 
@@ -48,10 +60,7 @@ from pprint import pprint
 
 # 1. Get your API host and token (e.g., from environment variables)
 api_host = os.environ.get("PERCEPTIC_CORE_HOST", "http://localhost:8080")
-access_token = os.environ.get("PERCEPTIC_CORE_TOKEN")
-
-if not access_token:
-    raise ValueError("Authentication token not found. Set PERCEPTIC_CORE_TOKEN environment variable.")
+access_token = get_access_token()
 
 # 2. Create a Configuration object
 configuration = Configuration(host=api_host)

{perceptic_core_client-0.7.1 → perceptic_core_client-0.7.2}/README.md

@@ -4,7 +4,7 @@ This package provides a generated Python client for interacting with the Percept
 
 ## Installation
 
-Install the package from the configured package registry (ensure `pip` is configured, see parent project documentation if using GitHub Packages):
+Install the package from the configured package registry (ensure `pip` is configured):
 
 ```bash
 pip install perceptic-core-client
@@ -13,6 +13,18 @@ pip install perceptic-core-client
 # pip install perceptic-core-client==<version>
 ```
 
+### Development
+
+`pip install -e .[dev]`
+
+This package gets automatically published to pip when a new version is tagged in the repository. The workflow file for this is located at `.github/workflows/publish-python.yml`. It will publish the same version as the one tagged in the repository.
+
+To generate the client code locally for testing o development, you can run:
+```bash
+python perceptic-core-python-client/scripts/generate_client.py --spec-path perceptic-core-server/openapi/openapi.json --version 0.5.0
+```
+Note that the `--version` doesn't really matter if generating locally and not publishing to pypi. It's only relevant if publishing the package to pypi, which is done automatically by the GitHub action.
+
 ## Basic Usage
 You need the URL of your Perceptic Core API instance and a valid authentication token (e.g., a Bearer token from Keycloak) obtained separately.
 
@@ -27,10 +39,7 @@ from pprint import pprint
 
 # 1. Get your API host and token (e.g., from environment variables)
 api_host = os.environ.get("PERCEPTIC_CORE_HOST", "http://localhost:8080")
-access_token = os.environ.get("PERCEPTIC_CORE_TOKEN")
-
-if not access_token:
-    raise ValueError("Authentication token not found. Set PERCEPTIC_CORE_TOKEN environment variable.")
+access_token = get_access_token()
 
 # 2. Create a Configuration object
 configuration = Configuration(host=api_host)

perceptic_core_client-0.7.2/VERSION

@@ -0,0 +1 @@
+0.7.2

{perceptic_core_client-0.7.1 → perceptic_core_client-0.7.2}/pyproject.toml

@@ -1,10 +1,10 @@
 [build-system]
-requires      = ["setuptools>=68", "wheel"]   # or hatchling / poetry-core / flit-core …
+requires      = ["setuptools>=68", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
 name             = "perceptic-core-client"
-dynamic = ["version"]
+dynamic          = ["version"]
 description      = "Python client for Perceptic Core"
 authors          = [{name = "Your Name", email = "you@example.com"}]
 readme           = "README.md"
@@ -28,7 +28,7 @@ dev = [
     "ruff",
     "mypy",
     "build",
-    "requests", # Also needed by the generate script itself
+    "requests",
 ]
 
 [tool.setuptools.packages.find]

{perceptic_core_client-0.7.1 → perceptic_core_client-0.7.2}/scripts/generate_client.py

@@ -4,7 +4,6 @@ import sys
 import os
 import shutil
 from pathlib import Path
-import json # For reading version from spec (optional)
 
 # --- Configuration ---
 PACKAGE_NAME = "perceptic_core_client"
@@ -73,10 +72,6 @@ def run_generator(spec_path: Path, output_dir: Path, package_name: str):
              print("Generator errors/warnings:", file=sys.stderr)
              print(process.stderr, file=sys.stderr)
         print("Client generation successful.")
-        # Optionally read version from spec if --version wasn't provided
-        # spec_content = json.loads(spec_path.read_text())
-        # version_from_spec = spec_content.get("info", {}).get("version")
-        # print(f"Version found in spec: {version_from_spec}") # For info only
         return True
     except subprocess.CalledProcessError as e:
         print(f"Error running openapi-generator-cli: {e}", file=sys.stderr)
@@ -107,7 +102,7 @@ def main():
         "--spec-path",
         type=Path,
         required=True,
-        help="Path to the local OpenAPI specification file (e.g., ../specs/openapi.yaml)"
+        help="Path to the local OpenAPI specification file"
     )
     parser.add_argument(
         "--version",

{perceptic_core_client-0.7.1 → perceptic_core_client-0.7.2}/src/perceptic_core_client/api/connection_resource_api.py

@@ -40,9 +40,9 @@ class ConnectionResourceApi:
 
 
     @validate_call
-    def api_v1_connections_connection_rid_get(
+    def create_connection(
         self,
-        connection_rid: StrictStr,
+        create_connection_request: CreateConnectionRequest,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -55,12 +55,12 @@ class ConnectionResourceApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> GetConnectionResponse:
-        """Get Connection
+    ) -> CreateConnectionResponse:
+        """Create Connection
 
 
-        :param connection_rid: (required)
-        :type connection_rid: str
+        :param create_connection_request: (required)
+        :type create_connection_request: CreateConnectionRequest
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -83,8 +83,8 @@ class ConnectionResourceApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._api_v1_connections_connection_rid_get_serialize(
-            connection_rid=connection_rid,
+        _param = self._create_connection_serialize(
+            create_connection_request=create_connection_request,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -92,7 +92,8 @@ class ConnectionResourceApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "GetConnectionResponse",
+            '200': "CreateConnectionResponse",
+            '400': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -106,9 +107,9 @@ class ConnectionResourceApi:
 
 
     @validate_call
-    def api_v1_connections_connection_rid_get_with_http_info(
+    def create_connection_with_http_info(
         self,
-        connection_rid: StrictStr,
+        create_connection_request: CreateConnectionRequest,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -121,12 +122,12 @@ class ConnectionResourceApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[GetConnectionResponse]:
-        """Get Connection
+    ) -> ApiResponse[CreateConnectionResponse]:
+        """Create Connection
 
 
-        :param connection_rid: (required)
-        :type connection_rid: str
+        :param create_connection_request: (required)
+        :type create_connection_request: CreateConnectionRequest
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -149,8 +150,8 @@ class ConnectionResourceApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._api_v1_connections_connection_rid_get_serialize(
-            connection_rid=connection_rid,
+        _param = self._create_connection_serialize(
+            create_connection_request=create_connection_request,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -158,7 +159,8 @@ class ConnectionResourceApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "GetConnectionResponse",
+            '200': "CreateConnectionResponse",
+            '400': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -172,9 +174,9 @@ class ConnectionResourceApi:
 
 
     @validate_call
-    def api_v1_connections_connection_rid_get_without_preload_content(
+    def create_connection_without_preload_content(
         self,
-        connection_rid: StrictStr,
+        create_connection_request: CreateConnectionRequest,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -188,11 +190,11 @@ class ConnectionResourceApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Get Connection
+        """Create Connection
 
 
-        :param connection_rid: (required)
-        :type connection_rid: str
+        :param create_connection_request: (required)
+        :type create_connection_request: CreateConnectionRequest
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -215,8 +217,8 @@ class ConnectionResourceApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._api_v1_connections_connection_rid_get_serialize(
-            connection_rid=connection_rid,
+        _param = self._create_connection_serialize(
+            create_connection_request=create_connection_request,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -224,7 +226,8 @@ class ConnectionResourceApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "GetConnectionResponse",
+            '200': "CreateConnectionResponse",
+            '400': None,
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -233,9 +236,9 @@ class ConnectionResourceApi:
         return response_data.response
 
 
-    def _api_v1_connections_connection_rid_get_serialize(
+    def _create_connection_serialize(
         self,
-        connection_rid,
+        create_connection_request,
         _request_auth,
         _content_type,
         _headers,
@@ -257,12 +260,12 @@ class ConnectionResourceApi:
         _body_params: Optional[bytes] = None
 
         # process the path parameters
-        if connection_rid is not None:
-            _path_params['connectionRid'] = connection_rid
         # process the query parameters
         # process the header parameters
         # process the form parameters
         # process the body parameter
+        if create_connection_request is not None:
+            _body_params = create_connection_request
 
 
         # set the HTTP header `Accept`
@@ -273,14 +276,27 @@ class ConnectionResourceApi:
                 ]
             )
 
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'application/json'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
 
         # authentication setting
         _auth_settings: List[str] = [
         ]
 
         return self.api_client.param_serialize(
-            method='GET',
-            resource_path='/api/v1/connections/{connectionRid}',
+            method='POST',
+            resource_path='/api/v1/connections',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,
@@ -297,9 +313,9 @@ class ConnectionResourceApi:
 
 
     @validate_call
-    def api_v1_connections_post(
+    def get_connection(
         self,
-        create_connection_request: CreateConnectionRequest,
+        connection_rid: StrictStr,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -312,12 +328,12 @@ class ConnectionResourceApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> CreateConnectionResponse:
-        """Create Connection
+    ) -> GetConnectionResponse:
+        """Get Connection
 
 
-        :param create_connection_request: (required)
-        :type create_connection_request: CreateConnectionRequest
+        :param connection_rid: (required)
+        :type connection_rid: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -340,8 +356,8 @@ class ConnectionResourceApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._api_v1_connections_post_serialize(
-            create_connection_request=create_connection_request,
+        _param = self._get_connection_serialize(
+            connection_rid=connection_rid,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -349,8 +365,7 @@ class ConnectionResourceApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "CreateConnectionResponse",
-            '400': None,
+            '200': "GetConnectionResponse",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -364,9 +379,9 @@ class ConnectionResourceApi:
 
 
     @validate_call
-    def api_v1_connections_post_with_http_info(
+    def get_connection_with_http_info(
         self,
-        create_connection_request: CreateConnectionRequest,
+        connection_rid: StrictStr,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -379,12 +394,12 @@ class ConnectionResourceApi:
         _content_type: Optional[StrictStr] = None,
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
-    ) -> ApiResponse[CreateConnectionResponse]:
-        """Create Connection
+    ) -> ApiResponse[GetConnectionResponse]:
+        """Get Connection
 
 
-        :param create_connection_request: (required)
-        :type create_connection_request: CreateConnectionRequest
+        :param connection_rid: (required)
+        :type connection_rid: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -407,8 +422,8 @@ class ConnectionResourceApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._api_v1_connections_post_serialize(
-            create_connection_request=create_connection_request,
+        _param = self._get_connection_serialize(
+            connection_rid=connection_rid,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -416,8 +431,7 @@ class ConnectionResourceApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "CreateConnectionResponse",
-            '400': None,
+            '200': "GetConnectionResponse",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -431,9 +445,9 @@ class ConnectionResourceApi:
 
 
     @validate_call
-    def api_v1_connections_post_without_preload_content(
+    def get_connection_without_preload_content(
         self,
-        create_connection_request: CreateConnectionRequest,
+        connection_rid: StrictStr,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -447,11 +461,11 @@ class ConnectionResourceApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Create Connection
+        """Get Connection
 
 
-        :param create_connection_request: (required)
-        :type create_connection_request: CreateConnectionRequest
+        :param connection_rid: (required)
+        :type connection_rid: str
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
                                  timeout. It can also be a pair (tuple) of
@@ -474,8 +488,8 @@ class ConnectionResourceApi:
         :return: Returns the result object.
         """ # noqa: E501
 
-        _param = self._api_v1_connections_post_serialize(
-            create_connection_request=create_connection_request,
+        _param = self._get_connection_serialize(
+            connection_rid=connection_rid,
             _request_auth=_request_auth,
             _content_type=_content_type,
             _headers=_headers,
@@ -483,8 +497,7 @@ class ConnectionResourceApi:
         )
 
         _response_types_map: Dict[str, Optional[str]] = {
-            '200': "CreateConnectionResponse",
-            '400': None,
+            '200': "GetConnectionResponse",
         }
         response_data = self.api_client.call_api(
             *_param,
@@ -493,9 +506,9 @@ class ConnectionResourceApi:
         return response_data.response
 
 
-    def _api_v1_connections_post_serialize(
+    def _get_connection_serialize(
         self,
-        create_connection_request,
+        connection_rid,
         _request_auth,
         _content_type,
         _headers,
@@ -517,12 +530,12 @@ class ConnectionResourceApi:
         _body_params: Optional[bytes] = None
 
         # process the path parameters
+        if connection_rid is not None:
+            _path_params['connectionRid'] = connection_rid
         # process the query parameters
         # process the header parameters
         # process the form parameters
         # process the body parameter
-        if create_connection_request is not None:
-            _body_params = create_connection_request
 
 
         # set the HTTP header `Accept`
@@ -533,27 +546,14 @@ class ConnectionResourceApi:
                 ]
             )
 
-        # set the HTTP header `Content-Type`
-        if _content_type:
-            _header_params['Content-Type'] = _content_type
-        else:
-            _default_content_type = (
-                self.api_client.select_header_content_type(
-                    [
-                        'application/json'
-                    ]
-                )
-            )
-            if _default_content_type is not None:
-                _header_params['Content-Type'] = _default_content_type
 
         # authentication setting
         _auth_settings: List[str] = [
         ]
 
         return self.api_client.param_serialize(
-            method='POST',
-            resource_path='/api/v1/connections',
+            method='GET',
+            resource_path='/api/v1/connections/{connectionRid}',
             path_params=_path_params,
             query_params=_query_params,
             header_params=_header_params,