forte-sdk 1.0.8__tar.gz

forte_sdk-1.0.8/PKG-INFO

@@ -0,0 +1,126 @@
+Metadata-Version: 2.4
+Name: forte-sdk
+Version: 1.0.8
+Summary: Official Python SDK for Forte Platforms
+Author-email: Forte Platforms <support@forteplatforms.com>
+License-Expression: MIT
+Project-URL: Repository, https://github.com/FortePlatforms/SDK
+Requires-Python: >=3.10
+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
+
+# Forte Platforms Python SDK
+
+Official Python SDK for interacting with the Forte Platforms API.
+
+## Installation
+
+```bash
+pip install forte-sdk
+```
+
+## Authentication
+
+Set your API token as an environment variable:
+
+```bash
+export FORTE_API_TOKEN=your_api_token_here
+```
+
+Or pass it directly when creating the client:
+
+```python
+client = ForteClient(api_token="your_api_token_here")
+```
+
+You can generate an API token from the Forte Platforms dashboard.
+
+## Quick Start
+
+```python
+from forte_sdk import ForteClient
+
+client = ForteClient()
+
+# List your projects
+projects = client.projects.list_projects()
+
+# Get a specific project
+project = client.projects.get_project(project_id="your-project-id")
+```
+
+## Custom Base URL
+
+```python
+client = ForteClient(base_url="https://custom-endpoint.example.com")
+```
+
+## Error Handling
+
+API errors are raised as exceptions:
+
+```python
+from forte_sdk.generated.exceptions import ApiException
+
+try:
+    project = client.projects.get_project(project_id="invalid-id")
+except ApiException as e:
+    print(f"API error {e.status}: {e.reason}")
+```
+
+## User Custom Attributes
+
+Store arbitrary key-value metadata on your users. Useful for tracking subscription tiers, feature flags, preferences, or any application-specific data.
+
+```python
+# Set custom attributes on a user
+user = client.projects.put_user_custom_attributes(
+    project_id="your-project-id",
+    user_id="user-id",
+    request_body={
+        "plan": "pro",
+        "referral_source": "google",
+        "onboarding_completed": "true",
+    },
+)
+
+print(user.custom_metadata_attributes)
+# {'plan': 'pro', 'referral_source': 'google', 'onboarding_completed': 'true'}
+```
+
+**Key constraints:**
+- Keys must be 1-64 characters: letters, numbers, underscores, and hyphens only
+- Values are strings
+- Each call replaces all existing attributes — include any you want to keep
+
+### Merge with existing attributes
+
+```python
+# Read current attributes, then merge
+user = client.projects.get_project_user(
+    project_id="your-project-id",
+    user_id="user-id",
+)
+
+client.projects.put_user_custom_attributes(
+    project_id="your-project-id",
+    user_id="user-id",
+    request_body={
+        **user.custom_metadata_attributes,
+        "plan": "enterprise",  # update one field
+    },
+)
+```
+
+## API Reference
+
+### `client.projects`
+
+Manage projects and services on Forte Platforms.
+
+### `client.users`
+
+Manage end-users within your projects.

forte_sdk-1.0.8/README.md

@@ -0,0 +1,112 @@
+# Forte Platforms Python SDK
+
+Official Python SDK for interacting with the Forte Platforms API.
+
+## Installation
+
+```bash
+pip install forte-sdk
+```
+
+## Authentication
+
+Set your API token as an environment variable:
+
+```bash
+export FORTE_API_TOKEN=your_api_token_here
+```
+
+Or pass it directly when creating the client:
+
+```python
+client = ForteClient(api_token="your_api_token_here")
+```
+
+You can generate an API token from the Forte Platforms dashboard.
+
+## Quick Start
+
+```python
+from forte_sdk import ForteClient
+
+client = ForteClient()
+
+# List your projects
+projects = client.projects.list_projects()
+
+# Get a specific project
+project = client.projects.get_project(project_id="your-project-id")
+```
+
+## Custom Base URL
+
+```python
+client = ForteClient(base_url="https://custom-endpoint.example.com")
+```
+
+## Error Handling
+
+API errors are raised as exceptions:
+
+```python
+from forte_sdk.generated.exceptions import ApiException
+
+try:
+    project = client.projects.get_project(project_id="invalid-id")
+except ApiException as e:
+    print(f"API error {e.status}: {e.reason}")
+```
+
+## User Custom Attributes
+
+Store arbitrary key-value metadata on your users. Useful for tracking subscription tiers, feature flags, preferences, or any application-specific data.
+
+```python
+# Set custom attributes on a user
+user = client.projects.put_user_custom_attributes(
+    project_id="your-project-id",
+    user_id="user-id",
+    request_body={
+        "plan": "pro",
+        "referral_source": "google",
+        "onboarding_completed": "true",
+    },
+)
+
+print(user.custom_metadata_attributes)
+# {'plan': 'pro', 'referral_source': 'google', 'onboarding_completed': 'true'}
+```
+
+**Key constraints:**
+- Keys must be 1-64 characters: letters, numbers, underscores, and hyphens only
+- Values are strings
+- Each call replaces all existing attributes — include any you want to keep
+
+### Merge with existing attributes
+
+```python
+# Read current attributes, then merge
+user = client.projects.get_project_user(
+    project_id="your-project-id",
+    user_id="user-id",
+)
+
+client.projects.put_user_custom_attributes(
+    project_id="your-project-id",
+    user_id="user-id",
+    request_body={
+        **user.custom_metadata_attributes,
+        "plan": "enterprise",  # update one field
+    },
+)
+```
+
+## API Reference
+
+### `client.projects`
+
+Manage projects and services on Forte Platforms.
+
+### `client.users`
+
+Manage end-users within your projects.

forte_sdk-1.0.8/forte_sdk/__init__.py

@@ -0,0 +1,27 @@
+import os
+
+from forte_sdk.generated import ApiClient, Configuration
+from forte_sdk.generated.api import ProjectsServerApi, UsersServerApi
+
+
+class ForteClient:
+    """Official Python client for the Forte Platforms API."""
+
+    def __init__(
+        self,
+        api_token: str | None = None,
+        base_url: str | None = None,
+    ):
+        token = api_token or os.environ.get("FORTE_API_TOKEN")
+        if not token:
+            raise ValueError(
+                "FORTE_API_TOKEN is required. "
+                "Set it as an environment variable or pass api_token."
+            )
+
+        config = Configuration(host=base_url or "https://api.forteplatforms.com")
+        client = ApiClient(config)
+        client.default_headers["Authorization"] = f"Bearer {token}"
+
+        self.projects = ProjectsServerApi(client)
+        self.users = UsersServerApi(client)

forte_sdk-1.0.8/forte_sdk/generated/__init__.py

@@ -0,0 +1,128 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    OpenAPI definition
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "1.0.8"
+
+# Define package exports
+__all__ = [
+    "ProjectsServerApi",
+    "UsersServerApi",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "AddContactMethodRequest",
+    "BuildStepLog",
+    "ContactMethod",
+    "CreateForteServiceRequest",
+    "CreateServiceRequestProxyRequest",
+    "CreateServiceRequestProxyResponse",
+    "DockerfileDetectionOutput",
+    "DockerfileGenerationError",
+    "DockerfileGenerationResponse",
+    "ForteApiException",
+    "HealthCheckConfig",
+    "HealthCheckDetectionError",
+    "HealthCheckDetectionOutput",
+    "HealthCheckDetectionResponse",
+    "LatencyMetrics",
+    "LatencyStats",
+    "LogLineObject",
+    "LoginUserResponse",
+    "PaginatedResponseLogLineObject",
+    "PaginatedResponseRequestLogObject",
+    "PaginatedResponseServiceBuildRequestObject",
+    "PaginatedResponseUserActionLogObject",
+    "PaginatedResponseUserObject",
+    "ProjectObject",
+    "RegisterUserRequest",
+    "RenewSessionTokenResponse",
+    "RepositoryAnalysis",
+    "RequestLogObject",
+    "RequestLogObjectMeta",
+    "ServiceBuildRequestObject",
+    "ServiceMetricsResponse",
+    "ServiceObject",
+    "TimeSeriesDataPoint",
+    "UpdateForteServiceRequest",
+    "UpdateForteServiceResponse",
+    "UpdateProjectRequest",
+    "UserActionLogObject",
+    "UserMetricsResponse",
+    "UserObject",
+]
+
+# import apis into sdk package
+from forte_sdk.generated.api.projects_server_api import ProjectsServerApi as ProjectsServerApi
+from forte_sdk.generated.api.users_server_api import UsersServerApi as UsersServerApi
+
+# import ApiClient
+from forte_sdk.generated.api_response import ApiResponse as ApiResponse
+from forte_sdk.generated.api_client import ApiClient as ApiClient
+from forte_sdk.generated.configuration import Configuration as Configuration
+from forte_sdk.generated.exceptions import OpenApiException as OpenApiException
+from forte_sdk.generated.exceptions import ApiTypeError as ApiTypeError
+from forte_sdk.generated.exceptions import ApiValueError as ApiValueError
+from forte_sdk.generated.exceptions import ApiKeyError as ApiKeyError
+from forte_sdk.generated.exceptions import ApiAttributeError as ApiAttributeError
+from forte_sdk.generated.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from forte_sdk.generated.models.add_contact_method_request import AddContactMethodRequest as AddContactMethodRequest
+from forte_sdk.generated.models.build_step_log import BuildStepLog as BuildStepLog
+from forte_sdk.generated.models.contact_method import ContactMethod as ContactMethod
+from forte_sdk.generated.models.create_forte_service_request import CreateForteServiceRequest as CreateForteServiceRequest
+from forte_sdk.generated.models.create_service_request_proxy_request import CreateServiceRequestProxyRequest as CreateServiceRequestProxyRequest
+from forte_sdk.generated.models.create_service_request_proxy_response import CreateServiceRequestProxyResponse as CreateServiceRequestProxyResponse
+from forte_sdk.generated.models.dockerfile_detection_output import DockerfileDetectionOutput as DockerfileDetectionOutput
+from forte_sdk.generated.models.dockerfile_generation_error import DockerfileGenerationError as DockerfileGenerationError
+from forte_sdk.generated.models.dockerfile_generation_response import DockerfileGenerationResponse as DockerfileGenerationResponse
+from forte_sdk.generated.models.forte_api_exception import ForteApiException as ForteApiException
+from forte_sdk.generated.models.health_check_config import HealthCheckConfig as HealthCheckConfig
+from forte_sdk.generated.models.health_check_detection_error import HealthCheckDetectionError as HealthCheckDetectionError
+from forte_sdk.generated.models.health_check_detection_output import HealthCheckDetectionOutput as HealthCheckDetectionOutput
+from forte_sdk.generated.models.health_check_detection_response import HealthCheckDetectionResponse as HealthCheckDetectionResponse
+from forte_sdk.generated.models.latency_metrics import LatencyMetrics as LatencyMetrics
+from forte_sdk.generated.models.latency_stats import LatencyStats as LatencyStats
+from forte_sdk.generated.models.log_line_object import LogLineObject as LogLineObject
+from forte_sdk.generated.models.login_user_response import LoginUserResponse as LoginUserResponse
+from forte_sdk.generated.models.paginated_response_log_line_object import PaginatedResponseLogLineObject as PaginatedResponseLogLineObject
+from forte_sdk.generated.models.paginated_response_request_log_object import PaginatedResponseRequestLogObject as PaginatedResponseRequestLogObject
+from forte_sdk.generated.models.paginated_response_service_build_request_object import PaginatedResponseServiceBuildRequestObject as PaginatedResponseServiceBuildRequestObject
+from forte_sdk.generated.models.paginated_response_user_action_log_object import PaginatedResponseUserActionLogObject as PaginatedResponseUserActionLogObject
+from forte_sdk.generated.models.paginated_response_user_object import PaginatedResponseUserObject as PaginatedResponseUserObject
+from forte_sdk.generated.models.project_object import ProjectObject as ProjectObject
+from forte_sdk.generated.models.register_user_request import RegisterUserRequest as RegisterUserRequest
+from forte_sdk.generated.models.renew_session_token_response import RenewSessionTokenResponse as RenewSessionTokenResponse
+from forte_sdk.generated.models.repository_analysis import RepositoryAnalysis as RepositoryAnalysis
+from forte_sdk.generated.models.request_log_object import RequestLogObject as RequestLogObject
+from forte_sdk.generated.models.request_log_object_meta import RequestLogObjectMeta as RequestLogObjectMeta
+from forte_sdk.generated.models.service_build_request_object import ServiceBuildRequestObject as ServiceBuildRequestObject
+from forte_sdk.generated.models.service_metrics_response import ServiceMetricsResponse as ServiceMetricsResponse
+from forte_sdk.generated.models.service_object import ServiceObject as ServiceObject
+from forte_sdk.generated.models.time_series_data_point import TimeSeriesDataPoint as TimeSeriesDataPoint
+from forte_sdk.generated.models.update_forte_service_request import UpdateForteServiceRequest as UpdateForteServiceRequest
+from forte_sdk.generated.models.update_forte_service_response import UpdateForteServiceResponse as UpdateForteServiceResponse
+from forte_sdk.generated.models.update_project_request import UpdateProjectRequest as UpdateProjectRequest
+from forte_sdk.generated.models.user_action_log_object import UserActionLogObject as UserActionLogObject
+from forte_sdk.generated.models.user_metrics_response import UserMetricsResponse as UserMetricsResponse
+from forte_sdk.generated.models.user_object import UserObject as UserObject
+

forte_sdk-1.0.8/forte_sdk/generated/api/__init__.py

@@ -0,0 +1,6 @@
+# flake8: noqa
+
+# import apis into api package
+from forte_sdk.generated.api.projects_server_api import ProjectsServerApi
+from forte_sdk.generated.api.users_server_api import UsersServerApi
+