perceptic-core-client 0.6.0__tar.gz → 0.6.2__tar.gz

perceptic_core_client-0.6.2/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: perceptic-core-client
+Version: 0.6.2
+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 (`perceptic-core-client`)
+
+This package provides a generated Python client for interacting with the Perceptic Core API.
+
+## Installation
+
+Install the package from the configured package registry (ensure `pip` is configured, see parent project documentation if using GitHub Packages):
+
+```bash
+pip install perceptic-core-client
+
+# To install a specific version:
+# pip install perceptic-core-client==<version>
+```
+
+## 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.
+
+```python
+import os
+from perceptic_core_client import ApiClient, Configuration, ApiException
+# Import the specific API category you need, e.g., UserResourceApi
+from perceptic_core_client.api.user_resource_api import UserResourceApi
+from pprint import pprint
+
+# --- Configuration ---
+
+# 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.")
+
+# 2. Create a Configuration object
+configuration = Configuration(host=api_host)
+
+# 3. Set the access token on the configuration
+configuration.access_token = access_token
+
+# 4. Create the main ApiClient
+api_client = ApiClient(configuration=configuration)
+
+# --- Making API Calls ---
+
+# 5. Instantiate the specific API resource class you want to use
+user_api = UserResourceApi(api_client=api_client)
+
+# 6. Call API methods
+try:
+    print(f"Fetching user info from {api_host}...")
+    me_response = user_api.api_v1_users_me_get()
+
+    print("API Call Successful:")
+    # Models often have a .to_dict() method for easy inspection
+    pprint(me_response.to_dict())
+
+except ApiException as e:
+    print(f"API Error: Status {e.status}, Reason: {e.reason}")
+    if e.body:
+        print(f"Body: {e.body}")
+except Exception as e:
+    print(f"An unexpected error occurred: {e}")
+
+# Example of another API (if you need to interact with connections)
+# from perceptic_core_client.api.connection_resource_api import ConnectionResourceApi
+# connection_api = ConnectionResourceApi(api_client=api_client)
+# try:
+#     # ... call methods on connection_api ...
+# except ApiException as e:
+#     # ... handle error ...
+```

perceptic_core_client-0.6.2/README.md

@@ -0,0 +1,72 @@
+# Perceptic Core API - Python Client (`perceptic-core-client`)
+
+This package provides a generated Python client for interacting with the Perceptic Core API.
+
+## Installation
+
+Install the package from the configured package registry (ensure `pip` is configured, see parent project documentation if using GitHub Packages):
+
+```bash
+pip install perceptic-core-client
+
+# To install a specific version:
+# pip install perceptic-core-client==<version>
+```
+
+## 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.
+
+```python
+import os
+from perceptic_core_client import ApiClient, Configuration, ApiException
+# Import the specific API category you need, e.g., UserResourceApi
+from perceptic_core_client.api.user_resource_api import UserResourceApi
+from pprint import pprint
+
+# --- Configuration ---
+
+# 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.")
+
+# 2. Create a Configuration object
+configuration = Configuration(host=api_host)
+
+# 3. Set the access token on the configuration
+configuration.access_token = access_token
+
+# 4. Create the main ApiClient
+api_client = ApiClient(configuration=configuration)
+
+# --- Making API Calls ---
+
+# 5. Instantiate the specific API resource class you want to use
+user_api = UserResourceApi(api_client=api_client)
+
+# 6. Call API methods
+try:
+    print(f"Fetching user info from {api_host}...")
+    me_response = user_api.api_v1_users_me_get()
+
+    print("API Call Successful:")
+    # Models often have a .to_dict() method for easy inspection
+    pprint(me_response.to_dict())
+
+except ApiException as e:
+    print(f"API Error: Status {e.status}, Reason: {e.reason}")
+    if e.body:
+        print(f"Body: {e.body}")
+except Exception as e:
+    print(f"An unexpected error occurred: {e}")
+
+# Example of another API (if you need to interact with connections)
+# from perceptic_core_client.api.connection_resource_api import ConnectionResourceApi
+# connection_api = ConnectionResourceApi(api_client=api_client)
+# try:
+#     # ... call methods on connection_api ...
+# except ApiException as e:
+#     # ... handle error ...
+```

perceptic_core_client-0.6.2/VERSION

@@ -0,0 +1 @@
+0.6.2

perceptic_core_client-0.6.2/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/perceptic_core_client'),
+    package_dir={'': 'src'},
+    # Ensure generated files are included.
+    include_package_data=True,
+    package_data={
+        "perceptic_core_client": ["**/*"],
+    },
+)

perceptic_core_client-0.6.2/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.2/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
+