luml-sdk 0.1.0rc1__tar.gz

luml_sdk-0.1.0rc1/.claude/settings.local.json

@@ -0,0 +1,8 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(. .venv/bin/activate)",
+      "Bash(python -m pytest:*)"
+    ]
+  }
+}

luml_sdk-0.1.0rc1/.gitignore

@@ -0,0 +1 @@
+uv.lock

luml_sdk-0.1.0rc1/.python-version

@@ -0,0 +1 @@
+3.12

luml_sdk-0.1.0rc1/PKG-INFO

@@ -0,0 +1,17 @@
+Metadata-Version: 2.4
+Name: luml_sdk
+Version: 0.1.0rc1
+Summary: LUML Python SDK
+Requires-Python: >=3.12
+Requires-Dist: pyfnx-utils<1.0.0,>=0.0.1
+Provides-Extra: api
+Requires-Dist: httpx<1.0.0,>=0.28.1; extra == 'api'
+Requires-Dist: pydantic<3.0.0,>=2.11.7; extra == 'api'
+Provides-Extra: core
+Requires-Dist: cloudpickle<4.0.0,>=3.1.2; extra == 'core'
+Requires-Dist: fnnx<0.1.0,>=0.0.8; extra == 'core'
+Requires-Dist: pydantic<3.0.0,>=2.11.7; extra == 'core'
+Provides-Extra: tracing
+Requires-Dist: opentelemetry-api>=1.36.0; extra == 'tracing'
+Requires-Dist: opentelemetry-instrumentation-openai>=0.44.1; extra == 'tracing'
+Requires-Dist: opentelemetry-sdk>=1.36.0; extra == 'tracing'

luml_sdk-0.1.0rc1/documentation/API/dataforce/api/_client.md

@@ -0,0 +1,297 @@
+---
+sidebar_label: _client
+title: dataforce.api._client
+---
+
+## DataForceClientBase
+
+```python
+class DataForceClientBase(ABC)
+```
+
+Base class for DataForce API clients.
+
+## AsyncDataForceClient
+
+```python
+class AsyncDataForceClient(DataForceClientBase, AsyncBaseClient)
+```
+
+#### \_\_init\_\_
+
+```python
+def __init__(base_url: str | None = None, api_key: str | None = None) -> None
+```
+
+Async client for interacting with the DataForce platform API.
+
+**Arguments**:
+
+- `base_url` - Base URL of the DataForce API.
+  Defaults to production DataForce Api URL: https://api.dataforce.studio.
+  Can also be set in env with name DFS_BASE_URL
+- `api_key` - Your DataForce API key for authentication.
+  Can also be set in env with name DFS_API_KEY
+  
+
+**Attributes**:
+
+- `organizations` - Interface for managing experiments.
+- `orbits` - Interface for managing orbits.
+- `collections` - Interface for managing collections.
+- `bucket_secrets` - Interface for managing bucket secrets.
+- `model_artifacts` - Interface for managing model artifacts.
+  
+
+**Raises**:
+
+- `AuthenticationError` - If API key is invalid or missing.
+- `ConfigurationError` - If required configuration is missing.
+- `OrganizationResourceNotFoundError` - If organization not found
+  by ID or name passed for client configuration.
+- `api_key`0 - If orbit not found by ID or name
+  passed for client configuration
+- `api_key`1 - If collection not found by ID or
+  name passed for client configuration
+  
+
+**Example**:
+
+  >>> dfs = DataForceClient(
+  ...     api_key="dfs_your_api_key",
+  ...     organization="0199c455-21ec-7c74-8efe-41470e29bae5",
+  ...     orbit="0199c455-21ed-7aba-9fe5-5231611220de"
+  ... )
+  
+  >>> dfs = DataForceClient(
+  ...     api_key="dfs_your_api_key",
+  ...     organization="My Personal Organization",
+  ...     orbit="Default Orbit"
+  ... )
+  
+
+**Notes**:
+
+  Default resource configuration is optional. If no values are provided during
+  client initialization and you have only one organization, orbit,
+  or collection, the appropriate resource will be automatically set as default
+  
+  Hierarchy constraints:
+  
+  - Cannot set default orbit without setting default organization first
+  - Cannot set default collection without setting default orbit first
+  - Default orbit must belong to the default organization
+  - Default collection must belong to the default orbit
+  
+  You can change default resource after client inizialization
+  `api_key`2dfs.organization=4`api_key`2.
+
+#### setup\_config
+
+```python
+async def setup_config(*,
+                       organization: str | None = None,
+                       orbit: str | None = None,
+                       collection: str | None = None) -> None
+```
+
+Method for setting default values for AsyncDataForceClient
+
+**Arguments**:
+
+- `organization` - Default organization to use for operations.
+  Can be set by organization ID or name.
+- `orbit` - Default orbit to use for operations.
+  Can be set by organization ID or name.
+- `collection` - Default collection to use for operations.
+  Can be set by organization ID or name.
+  
+
+**Example**:
+
+  >>> dfs = AsyncDataForceClient(api_key="dfs_api_key")
+  >>> async def main():
+  ...     await dfs.setup_config(
+  ...         "0199c455-21ec-7c74-8efe-41470e29bae5",
+  ...         "0199c455-21ed-7aba-9fe5-5231611220de",
+  ...         "0199c455-21ee-74c6-b747-19a82f1a1e75"
+  ...     )
+
+#### organizations
+
+```python
+@cached_property
+def organizations() -> "AsyncOrganizationResource"
+```
+
+Organizations interface.
+
+#### bucket\_secrets
+
+```python
+@cached_property
+def bucket_secrets() -> "AsyncBucketSecretResource"
+```
+
+Bucket Secrets interface.
+
+#### orbits
+
+```python
+@cached_property
+def orbits() -> "AsyncOrbitResource"
+```
+
+Orbits interface.
+
+#### collections
+
+```python
+@cached_property
+def collections() -> "AsyncCollectionResource"
+```
+
+Collections interface.
+
+#### model\_artifacts
+
+```python
+@cached_property
+def model_artifacts() -> "AsyncModelArtifactResource"
+```
+
+Model Artifacts interface.
+
+## DataForceClient
+
+```python
+class DataForceClient(DataForceClientBase, SyncBaseClient)
+```
+
+#### \_\_init\_\_
+
+```python
+def __init__(base_url: str | None = None,
+             api_key: str | None = None,
+             organization: str | None = None,
+             orbit: str | None = None,
+             collection: str | None = None) -> None
+```
+
+Client for interacting with the DataForce platform API.
+
+**Arguments**:
+
+- `base_url` - Base URL of the DataForce API.
+  Defaults to production DataForce Api URL: https://api.dataforce.studio.
+  Can also be set in env with name DFS_BASE_URL
+- `api_key` - Your DataForce API key for authentication.
+  Can also be set in env with name DFS_API_KEY
+- `organization` - Default organization to use for operations.
+  Can be set by organization ID or name.
+- `orbit` - Default orbit to use for operations.
+  Can be set by organization ID or name.
+- `collection` - Default collection to use for operations.
+  Can be set by organization ID or name.
+  
+
+**Attributes**:
+
+- `organizations` - Interface for managing experiments.
+- `orbits` - Interface for managing orbits.
+- `collections` - Interface for managing collections.
+- `bucket_secrets` - Interface for managing bucket secrets.
+- `model_artifacts` - Interface for managing model artifacts.
+  
+
+**Raises**:
+
+- `api_key`0 - If API key is invalid or missing.
+- `api_key`1 - If required configuration is missing.
+- `api_key`2 - If organization not found by ID
+  or name passed for client configuration
+- `api_key`3 - If orbit not found by ID
+  or name passed for client configuration
+- `api_key`4 - If collection not found
+  by ID or name passed for client configuration
+  
+
+**Example**:
+
+  >>> dfs = DataForceClient(
+  ...     api_key="dfs_your_api_key",
+  ...     organization="0199c455-21ec-7c74-8efe-41470e29bae5",
+  ...     orbit="0199c455-21ed-7aba-9fe5-5231611220de"
+  ... )
+  
+  >>> dfs = DataForceClient(
+  ...     api_key="dfs_your_api_key",
+  ...     organization="My Personal Organization",
+  ...     orbit="Default Orbit"
+  ... )
+  
+
+**Notes**:
+
+  For long-running operations, consider using the async version:
+  AsyncDataForceClient.
+  
+  Default resource configuration is optional. If no values are provided during
+  client initialization and you have only one organization, orbit,
+  or collection, the appropriate resource will be automatically set as default
+  
+  Hierarchy constraints:
+  
+  - Cannot set default orbit without setting default organization first
+  - Cannot set default collection without setting default orbit first
+  - Default orbit must belong to the default organization
+  - Default collection must belong to the default orbit
+  
+  You can change default resource after client inizialization
+  `api_key`5dfs.organization="0199c455-21ec-7c74-8efe-41470e29bae5"`api_key`5.
+
+#### organizations
+
+```python
+@cached_property
+def organizations() -> "OrganizationResource"
+```
+
+Organizations interface.
+
+#### bucket\_secrets
+
+```python
+@cached_property
+def bucket_secrets() -> "BucketSecretResource"
+```
+
+Bucket Secrets interface.
+
+#### orbits
+
+```python
+@cached_property
+def orbits() -> "OrbitResource"
+```
+
+Orbits interface.
+
+#### collections
+
+```python
+@cached_property
+def collections() -> "CollectionResource"
+```
+
+Collections interface.
+
+#### model\_artifacts
+
+```python
+@cached_property
+def model_artifacts() -> "ModelArtifactResource"
+```
+
+Model Artifacts interface.
+