perceptic-core-client 0.5.12__tar.gz → 0.6.1__tar.gz

perceptic_core_client-0.6.1/PKG-INFO

@@ -0,0 +1,179 @@
+Metadata-Version: 2.4
+Name: perceptic-core-client
+Version: 0.6.1
+Summary: Python client for Perceptic Core
+Author-email: Your Name <you@example.com>
+License: Proprietary
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: urllib3<3.0.0,>=2.1.0
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: pydantic>=2
+Requires-Dist: typing-extensions>=4.7.1
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: requests; extra == "dev"
+
+# Perceptic Core API - Python Client Package
+
+This directory contains the source code, build configuration, and generation scripts for the `perceptic-core-client` Python package. This package provides a client library for interacting with the Perceptic Core API.
+
+**Note:** The actual client code within `src/perceptic_core_client/` is automatically generated during the build process from the OpenAPI specification located in the parent `perceptic-core-server` project (`../openapi/`) and is **not** checked into Git.
+
+## Generation Process
+
+The Python client code is generated using `openapi-generator-cli` based on the OpenAPI specification found at `../openapi/openapi.yaml` (relative to this directory).
+
+This generation happens automatically as part of the package build process (`python -m build`) defined in `setup.py`.
+
+**Requirements for Building:**
+* Python >= 3.9
+* `setuptools`, `wheel`, `build` Python packages
+* Java Runtime Environment (JRE)
+* `openapi-generator-cli` (Installable via npm: `npm install -g @openapitools/openapi-generator-cli`)
+* The `PACKAGE_VERSION` environment variable must be set to the desired version string (e.g., `0.5.0`) before building.
+* The OpenAPI spec file (`../openapi/openapi.yaml` or `.json`) must exist, typically generated by the parent Quarkus project's build.
+
+## Building Manually (for Development/Testing)
+
+While the primary build and publish mechanism is via GitHub Actions, you can build the package locally for testing:
+
+1.  **Navigate** to this directory (`perceptic-core-python-client`).
+2.  **Set up environment:**
+    ```bash
+    # Create/activate a virtual environment
+    python -m venv .venv
+    source .venv/bin/activate # Linux/macOS
+    # .venv\Scripts\activate # Windows
+
+    # Install build and dev dependencies
+    pip install -e ".[dev]"
+    ```
+3.  **Set required environment variables:**
+    ```bash
+    # Bash/Zsh
+    export PACKAGE_VERSION="<target-version>" # e.g., 0.5.1.dev0
+    # OPENAPI_SPEC_PATH is determined automatically by setup.py now
+
+    # Windows CMD
+    # set PACKAGE_VERSION=<target-version>
+
+    # Windows PowerShell
+    # $env:PACKAGE_VERSION = "<target-version>"
+    ```
+4.  **Run build:** Ensure the spec file exists at `../openapi/openapi.yaml` (or `.json`).
+    ```bash
+    python -m build
+    ```
+    This will generate the client code in `src/` and create distribution files (`.whl`, `.tar.gz`) in the `dist/` directory.
+
+## Publishing
+
+This package is automatically published to GitHub Packages via the GitHub Actions workflow defined in `.github/workflows/publish-python-client.yml` in the root of the `perceptic-core-server` repository. Publishing is triggered when a Git tag (e.g., `0.5.0`, `1.0.0`) is pushed to the repository.
+
+## Installation (from GitHub Packages)
+
+To use this client in your Python projects, install it from GitHub Packages.
+
+1.  **Configure pip:** You need to tell pip where to find the package. Add the following lines to your `pip.conf` / `pip.ini` file, or configure it using environment variables/command-line arguments. Replace `<YOUR_GITHUB_OWNER>` with the GitHub username or organization that owns the repository (e.g., `perceptic-core`).
+
+    ```ini
+    [global]
+    extra-index-url = [https://pypi.pkg.github.com/](https://pypi.pkg.github.com/)<YOUR_GITHUB_OWNER>/
+    ```
+    *Alternatively, use `--extra-index-url` on the command line.*
+
+2.  **Authentication (if repository is private):** You may need to authenticate pip to GitHub Packages. The recommended method is using a Personal Access Token (PAT) with the `read:packages` scope. Configure pip to use your GitHub username and the PAT. Refer to GitHub documentation for the latest authentication methods.
+
+3.  **Install the package:**
+    ```bash
+    pip install perceptic-core-client
+    ```
+    *(Specify a version if needed: `pip install perceptic-core-client==<version>`)*
+
+## Usage Example
+
+```python
+import os
+from perceptic_core_client import ApiClient, Configuration, ApiException
+from perceptic_core_client.api.user_resource_api import UserResourceApi # Example API
+from pprint import pprint
+
+# --- Configuration ---
+# Replace with the actual host of your Perceptic Core API instance
+API_HOST = os.environ.get("PERCEPTIC_CORE_HOST", "http://localhost:8080")
+
+# Obtain your authentication token separately
+# (e.g., from Keycloak, environment variable, another library)
+ACCESS_TOKEN = os.environ.get("PERCEPTIC_CORE_TOKEN")
+
+if not ACCESS_TOKEN:
+    print("Error: PERCEPTIC_CORE_TOKEN environment variable not set.")
+    exit(1)
+# ---
+
+print(f"Configuring client for host: {API_HOST}")
+
+# Configure API client
+configuration = Configuration(host=API_HOST)
+configuration.access_token = ACCESS_TOKEN # Set token for potential internal use
+
+# Initialize API client
+api_client = ApiClient(configuration=configuration)
+
+# Explicitly set the Authorization header (recommended)
+api_client.set_default_header("Authorization", f"Bearer {ACCESS_TOKEN}")
+
+# --- Example API Call: Get current user info ---
+user_api = UserResourceApi(api_client=api_client)
+
+try:
+    print("Calling /api/v1/users/me...")
+    me_response = user_api.api_v1_users_me_get()
+    print("API call successful. User Info:")
+    pprint(me_response.to_dict()) # Use to_dict() for cleaner printing
+
+except ApiException as e:
+    print(f"API Exception calling UserResourceApi->api_v1_users_me_get: {e}\n")
+    # You can inspect e.status, e.reason, e.body, e.headers
+except Exception as e:
+    print(f"An unexpected error occurred: {e}\n")
+
+# --- Example: Create a Connection (replace with actual details) ---
+# from perceptic_core_client.api.connection_resource_api import ConnectionResourceApi
+# from perceptic_core_client.models import (
+#     CreateConnectionRequest,
+#     ConnectionSettingsApiDto,
+#     S3ConnectionSettingsApiDto # Example setting type
+# )
+#
+# connection_api = ConnectionResourceApi(api_client=api_client)
+#
+# try:
+#     print("Attempting to create a connection...")
+#     connection_request = CreateConnectionRequest(
+#         name="my-s3-connection",
+#         description="Connection to my S3 bucket",
+#         settings=ConnectionSettingsApiDto(
+#             actual_instance=S3ConnectionSettingsApiDto(
+#                 type="v1/s3",
+#                 region="us-east-1", # Replace with actual values
+#                 access_key="YOUR_ACCESS_KEY",
+#                 secret_key="YOUR_SECRET_KEY",
+#                 url="[https://s3.amazonaws.com](https://s3.amazonaws.com)" # Optional endpoint URL
+#             )
+#         )
+#     )
+#     create_response = connection_api.api_v1_connections_post(connection_request)
+#     print("Connection created successfully:")
+#     pprint(create_response.to_dict())
+#
+# except ApiException as e:
+#     print(f"API Exception creating connection: {e}\n")
+# except Exception as e:
+#     print(f"An unexpected error occurred: {e}\n")

perceptic_core_client-0.6.1/README.md

@@ -0,0 +1,158 @@
+# Perceptic Core API - Python Client Package
+
+This directory contains the source code, build configuration, and generation scripts for the `perceptic-core-client` Python package. This package provides a client library for interacting with the Perceptic Core API.
+
+**Note:** The actual client code within `src/perceptic_core_client/` is automatically generated during the build process from the OpenAPI specification located in the parent `perceptic-core-server` project (`../openapi/`) and is **not** checked into Git.
+
+## Generation Process
+
+The Python client code is generated using `openapi-generator-cli` based on the OpenAPI specification found at `../openapi/openapi.yaml` (relative to this directory).
+
+This generation happens automatically as part of the package build process (`python -m build`) defined in `setup.py`.
+
+**Requirements for Building:**
+* Python >= 3.9
+* `setuptools`, `wheel`, `build` Python packages
+* Java Runtime Environment (JRE)
+* `openapi-generator-cli` (Installable via npm: `npm install -g @openapitools/openapi-generator-cli`)
+* The `PACKAGE_VERSION` environment variable must be set to the desired version string (e.g., `0.5.0`) before building.
+* The OpenAPI spec file (`../openapi/openapi.yaml` or `.json`) must exist, typically generated by the parent Quarkus project's build.
+
+## Building Manually (for Development/Testing)
+
+While the primary build and publish mechanism is via GitHub Actions, you can build the package locally for testing:
+
+1.  **Navigate** to this directory (`perceptic-core-python-client`).
+2.  **Set up environment:**
+    ```bash
+    # Create/activate a virtual environment
+    python -m venv .venv
+    source .venv/bin/activate # Linux/macOS
+    # .venv\Scripts\activate # Windows
+
+    # Install build and dev dependencies
+    pip install -e ".[dev]"
+    ```
+3.  **Set required environment variables:**
+    ```bash
+    # Bash/Zsh
+    export PACKAGE_VERSION="<target-version>" # e.g., 0.5.1.dev0
+    # OPENAPI_SPEC_PATH is determined automatically by setup.py now
+
+    # Windows CMD
+    # set PACKAGE_VERSION=<target-version>
+
+    # Windows PowerShell
+    # $env:PACKAGE_VERSION = "<target-version>"
+    ```
+4.  **Run build:** Ensure the spec file exists at `../openapi/openapi.yaml` (or `.json`).
+    ```bash
+    python -m build
+    ```
+    This will generate the client code in `src/` and create distribution files (`.whl`, `.tar.gz`) in the `dist/` directory.
+
+## Publishing
+
+This package is automatically published to GitHub Packages via the GitHub Actions workflow defined in `.github/workflows/publish-python-client.yml` in the root of the `perceptic-core-server` repository. Publishing is triggered when a Git tag (e.g., `0.5.0`, `1.0.0`) is pushed to the repository.
+
+## Installation (from GitHub Packages)
+
+To use this client in your Python projects, install it from GitHub Packages.
+
+1.  **Configure pip:** You need to tell pip where to find the package. Add the following lines to your `pip.conf` / `pip.ini` file, or configure it using environment variables/command-line arguments. Replace `<YOUR_GITHUB_OWNER>` with the GitHub username or organization that owns the repository (e.g., `perceptic-core`).
+
+    ```ini
+    [global]
+    extra-index-url = [https://pypi.pkg.github.com/](https://pypi.pkg.github.com/)<YOUR_GITHUB_OWNER>/
+    ```
+    *Alternatively, use `--extra-index-url` on the command line.*
+
+2.  **Authentication (if repository is private):** You may need to authenticate pip to GitHub Packages. The recommended method is using a Personal Access Token (PAT) with the `read:packages` scope. Configure pip to use your GitHub username and the PAT. Refer to GitHub documentation for the latest authentication methods.
+
+3.  **Install the package:**
+    ```bash
+    pip install perceptic-core-client
+    ```
+    *(Specify a version if needed: `pip install perceptic-core-client==<version>`)*
+
+## Usage Example
+
+```python
+import os
+from perceptic_core_client import ApiClient, Configuration, ApiException
+from perceptic_core_client.api.user_resource_api import UserResourceApi # Example API
+from pprint import pprint
+
+# --- Configuration ---
+# Replace with the actual host of your Perceptic Core API instance
+API_HOST = os.environ.get("PERCEPTIC_CORE_HOST", "http://localhost:8080")
+
+# Obtain your authentication token separately
+# (e.g., from Keycloak, environment variable, another library)
+ACCESS_TOKEN = os.environ.get("PERCEPTIC_CORE_TOKEN")
+
+if not ACCESS_TOKEN:
+    print("Error: PERCEPTIC_CORE_TOKEN environment variable not set.")
+    exit(1)
+# ---
+
+print(f"Configuring client for host: {API_HOST}")
+
+# Configure API client
+configuration = Configuration(host=API_HOST)
+configuration.access_token = ACCESS_TOKEN # Set token for potential internal use
+
+# Initialize API client
+api_client = ApiClient(configuration=configuration)
+
+# Explicitly set the Authorization header (recommended)
+api_client.set_default_header("Authorization", f"Bearer {ACCESS_TOKEN}")
+
+# --- Example API Call: Get current user info ---
+user_api = UserResourceApi(api_client=api_client)
+
+try:
+    print("Calling /api/v1/users/me...")
+    me_response = user_api.api_v1_users_me_get()
+    print("API call successful. User Info:")
+    pprint(me_response.to_dict()) # Use to_dict() for cleaner printing
+
+except ApiException as e:
+    print(f"API Exception calling UserResourceApi->api_v1_users_me_get: {e}\n")
+    # You can inspect e.status, e.reason, e.body, e.headers
+except Exception as e:
+    print(f"An unexpected error occurred: {e}\n")
+
+# --- Example: Create a Connection (replace with actual details) ---
+# from perceptic_core_client.api.connection_resource_api import ConnectionResourceApi
+# from perceptic_core_client.models import (
+#     CreateConnectionRequest,
+#     ConnectionSettingsApiDto,
+#     S3ConnectionSettingsApiDto # Example setting type
+# )
+#
+# connection_api = ConnectionResourceApi(api_client=api_client)
+#
+# try:
+#     print("Attempting to create a connection...")
+#     connection_request = CreateConnectionRequest(
+#         name="my-s3-connection",
+#         description="Connection to my S3 bucket",
+#         settings=ConnectionSettingsApiDto(
+#             actual_instance=S3ConnectionSettingsApiDto(
+#                 type="v1/s3",
+#                 region="us-east-1", # Replace with actual values
+#                 access_key="YOUR_ACCESS_KEY",
+#                 secret_key="YOUR_SECRET_KEY",
+#                 url="[https://s3.amazonaws.com](https://s3.amazonaws.com)" # Optional endpoint URL
+#             )
+#         )
+#     )
+#     create_response = connection_api.api_v1_connections_post(connection_request)
+#     print("Connection created successfully:")
+#     pprint(create_response.to_dict())
+#
+# except ApiException as e:
+#     print(f"API Exception creating connection: {e}\n")
+# except Exception as e:
+#     print(f"An unexpected error occurred: {e}\n")

perceptic_core_client-0.6.1/VERSION

@@ -0,0 +1 @@
+0.6.1

perceptic_core_client-0.6.1/setup.py

@@ -0,0 +1,13 @@
+from setuptools import setup, find_packages
+
+setup(
+    # Let pyproject.toml handle most metadata & dynamic versioning.
+    # Explicitly find packages in 'src' layout.
+    packages=find_packages(where='src'),
+    package_dir={'': 'src'},
+    # Ensure generated files are included.
+    include_package_data=True,
+    package_data={
+        "perceptic_core_client": ["**/*"],
+    },
+)

perceptic_core_client-0.6.1/src/perceptic_core_client/perceptic_core_client/__init__.py

@@ -0,0 +1,101 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    perceptic-core-server API
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.0.1-SNAPSHOT
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.0"
+
+# import apis into sdk package
+from perceptic_core_client.api.connection_resource_api import ConnectionResourceApi
+from perceptic_core_client.api.file_system_contents_resource_api import FileSystemContentsResourceApi
+from perceptic_core_client.api.file_system_resource_api import FileSystemResourceApi
+from perceptic_core_client.api.indexer_resource_api import IndexerResourceApi
+from perceptic_core_client.api.indexing_task_resource_api import IndexingTaskResourceApi
+from perceptic_core_client.api.uri_resource_api import UriResourceApi
+from perceptic_core_client.api.user_resource_api import UserResourceApi
+from perceptic_core_client.api.worker_resource_api import WorkerResourceApi
+
+# import ApiClient
+from perceptic_core_client.api_response import ApiResponse
+from perceptic_core_client.api_client import ApiClient
+from perceptic_core_client.configuration import Configuration
+from perceptic_core_client.exceptions import OpenApiException
+from perceptic_core_client.exceptions import ApiTypeError
+from perceptic_core_client.exceptions import ApiValueError
+from perceptic_core_client.exceptions import ApiKeyError
+from perceptic_core_client.exceptions import ApiAttributeError
+from perceptic_core_client.exceptions import ApiException
+
+# import models into sdk package
+from perceptic_core_client.models.action_type import ActionType
+from perceptic_core_client.models.azure_blob_connection_settings_api_dto import AzureBlobConnectionSettingsApiDto
+from perceptic_core_client.models.azure_blob_file_system_root_metadata_api_dto import AzureBlobFileSystemRootMetadataApiDto
+from perceptic_core_client.models.connection_api_dto import ConnectionApiDto
+from perceptic_core_client.models.connection_settings_api_dto import ConnectionSettingsApiDto
+from perceptic_core_client.models.create_connection_request import CreateConnectionRequest
+from perceptic_core_client.models.create_connection_response import CreateConnectionResponse
+from perceptic_core_client.models.create_file_system_response import CreateFileSystemResponse
+from perceptic_core_client.models.create_folder_request import CreateFolderRequest
+from perceptic_core_client.models.create_folder_response import CreateFolderResponse
+from perceptic_core_client.models.create_indexing_task_request import CreateIndexingTaskRequest
+from perceptic_core_client.models.create_indexing_task_response import CreateIndexingTaskResponse
+from perceptic_core_client.models.create_managed_file_system_request import CreateManagedFileSystemRequest
+from perceptic_core_client.models.create_remote_file_system_request import CreateRemoteFileSystemRequest
+from perceptic_core_client.models.file_system_api_dto import FileSystemApiDto
+from perceptic_core_client.models.file_system_root_metadata_api_dto import FileSystemRootMetadataApiDto
+from perceptic_core_client.models.get_connection_response import GetConnectionResponse
+from perceptic_core_client.models.get_indexer_response import GetIndexerResponse
+from perceptic_core_client.models.get_indexing_task_response import GetIndexingTaskResponse
+from perceptic_core_client.models.get_metadata_response import GetMetadataResponse
+from perceptic_core_client.models.get_parent_response import GetParentResponse
+from perceptic_core_client.models.get_parent_uri_response import GetParentUriResponse
+from perceptic_core_client.models.get_signed_url_response import GetSignedUrlResponse
+from perceptic_core_client.models.get_worker_events_response import GetWorkerEventsResponse
+from perceptic_core_client.models.get_worker_metadata_response import GetWorkerMetadataResponse
+from perceptic_core_client.models.get_worker_status_response import GetWorkerStatusResponse
+from perceptic_core_client.models.get_workers_response import GetWorkersResponse
+from perceptic_core_client.models.indexer_dto import IndexerDto
+from perceptic_core_client.models.indexing_action_dto import IndexingActionDto
+from perceptic_core_client.models.indexing_action_status import IndexingActionStatus
+from perceptic_core_client.models.indexing_task_dto import IndexingTaskDto
+from perceptic_core_client.models.indexing_task_status import IndexingTaskStatus
+from perceptic_core_client.models.info_event import InfoEvent
+from perceptic_core_client.models.json_node import JsonNode
+from perceptic_core_client.models.json_node_type import JsonNodeType
+from perceptic_core_client.models.list_all_file_systems_response import ListAllFileSystemsResponse
+from perceptic_core_client.models.list_file_system_response import ListFileSystemResponse
+from perceptic_core_client.models.list_indexers_response import ListIndexersResponse
+from perceptic_core_client.models.list_indexing_actions_response import ListIndexingActionsResponse
+from perceptic_core_client.models.managed_file_system_api_dto import ManagedFileSystemApiDto
+from perceptic_core_client.models.me_response import MeResponse
+from perceptic_core_client.models.model_schema import ModelSchema
+from perceptic_core_client.models.paged_list_file_system_response import PagedListFileSystemResponse
+from perceptic_core_client.models.post_worker_run_request import PostWorkerRunRequest
+from perceptic_core_client.models.post_worker_run_response import PostWorkerRunResponse
+from perceptic_core_client.models.progress_event import ProgressEvent
+from perceptic_core_client.models.remote_file_system_api_dto import RemoteFileSystemApiDto
+from perceptic_core_client.models.request_for_input_event import RequestForInputEvent
+from perceptic_core_client.models.resource_entry_dto import ResourceEntryDto
+from perceptic_core_client.models.resource_id import ResourceId
+from perceptic_core_client.models.resource_identifier import ResourceIdentifier
+from perceptic_core_client.models.resource_metadata_dto import ResourceMetadataDto
+from perceptic_core_client.models.resource_type_dto import ResourceTypeDto
+from perceptic_core_client.models.run_status_dto import RunStatusDto
+from perceptic_core_client.models.s3_connection_settings_api_dto import S3ConnectionSettingsApiDto
+from perceptic_core_client.models.s3_file_system_root_metadata_api_dto import S3FileSystemRootMetadataApiDto
+from perceptic_core_client.models.schema_location import SchemaLocation
+from perceptic_core_client.models.start_execution_response import StartExecutionResponse
+from perceptic_core_client.models.upload_file_to_managed_file_system_response import UploadFileToManagedFileSystemResponse
+from perceptic_core_client.models.worker_event import WorkerEvent
+from perceptic_core_client.models.worker_metadata_dto import WorkerMetadataDto

perceptic_core_client-0.6.1/src/perceptic_core_client/perceptic_core_client/api/__init__.py

@@ -0,0 +1,12 @@
+# flake8: noqa
+
+# import apis into api package
+from perceptic_core_client.api.connection_resource_api import ConnectionResourceApi
+from perceptic_core_client.api.file_system_contents_resource_api import FileSystemContentsResourceApi
+from perceptic_core_client.api.file_system_resource_api import FileSystemResourceApi
+from perceptic_core_client.api.indexer_resource_api import IndexerResourceApi
+from perceptic_core_client.api.indexing_task_resource_api import IndexingTaskResourceApi
+from perceptic_core_client.api.uri_resource_api import UriResourceApi
+from perceptic_core_client.api.user_resource_api import UserResourceApi
+from perceptic_core_client.api.worker_resource_api import WorkerResourceApi
+