luml-api 0.1.0rc0__tar.gz

luml_api-0.1.0rc0/.gitignore

@@ -0,0 +1,23 @@
+wasm/packages/dfs_webworker/dfs_webworker/prompt_optimization/serialization/__fnnx_autogen_content.py
+wasm/test_*.py
+/backend/.env
+/.idea/.gitignore
+/backend/.coverage
+/backend/luml/factories/
+/.gitignore
+__pycache__/
+*.py[cod]
+.DS_Store
+/sdk/python/venv/
+/.idea/
+/satellite/.env
+/lumlflow/.idea
+/lumlflow/frontend/node_modules
+/lumlflow/frontend/dist
+/lumlflow/lumlflow/static
+/sdk/python/sdk_docs_generate.py
+node_modules
+/lumlflow/.idea/
+/lumlflow/.env
+/sdk/python/api/.venv/
+/sdk/python/sdk/.venv/

luml_api-0.1.0rc0/.python-version

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

luml_api-0.1.0rc0/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.4
+Name: luml-api
+Version: 0.1.0rc0
+Summary: LUML Python API Client
+Requires-Python: >=3.12
+Requires-Dist: cloudpickle<4.0.0,>=3.1.2
+Requires-Dist: fnnx<0.1.0,>=0.0.8
+Requires-Dist: httpx<1.0.0,>=0.28.1
+Requires-Dist: pydantic<3.0.0,>=2.11.7
+Requires-Dist: pyfnx-utils<1.0.0,>=0.0.1

luml_api-0.1.0rc0/examples/async_demo.py

@@ -0,0 +1,244 @@
+# ruff: noqa: T201
+import asyncio
+
+from luml_api import AsyncLumlClient
+from luml_api._types import CollectionType, ModelArtifactStatus
+
+# Will use Luml API Production url "https://api.luml.ai"
+# And search for LUML_API_KEY in .env
+luml_simple = AsyncLumlClient()
+
+# No default organization, orbit and collection are set
+luml = AsyncLumlClient(api_key="luml_your_api_key_here")
+
+
+async def demo_client_defaults() -> None:
+    # Set up defaults
+    await luml.setup_config(
+        organization="0199c455-21ec-7c74-8efe-41470e29bae5",
+        orbit="0199c455-21ed-7aba-9fe5-5231611220de",
+        collection="0199c455-21ee-74c6-b747-19a82f1a1e75",
+    )
+
+    # Get client defaults ids
+    default_organization_id = luml.organization
+    default_orbit_id = luml.orbit
+    default_collection_id = luml.collection
+
+    print(default_organization_id, default_orbit_id, default_collection_id)
+
+    # Set default resources
+    luml.organization = "0199c455-21ec-7c74-8efe-41470e29bae5"
+    luml.orbit = "0199c455-21ed-7aba-9fe5-5231611220de"
+    luml.collection = "0199c455-21ee-74c6-b747-19a82f1a1e75"
+
+    print(luml.organization, luml.orbit, luml.collection)
+
+
+async def demo_organizations() -> None:
+    # List all available organization for user
+    all_my_organization = await luml.organizations.list()
+    print(f"All user organization: {all_my_organization}")
+
+    # Get default organization
+    default_org_details = await luml.organizations.get()
+    print(f"Default organization: {default_org_details}")
+
+    # Get organization by name
+    organization_by_name = await luml.organizations.get("My Organization")
+    print(f"Organization by name: {organization_by_name}")
+
+    # Get organization by id
+    organization_by_id = await luml.organizations.get(
+        "0199c455-21ec-7c74-8efe-41470e29bae5"
+    )
+    print(f"Organization by id: {organization_by_id}")
+
+
+async def demo_bucket_secrets() -> None:
+    # Create a new bucket secret
+    bucket_secret = await luml.bucket_secrets.create(
+        endpoint="s3.amazonaws.com",
+        bucket_name="my-ml-models-bucket",
+        access_key="AKIAIOSFODNN7EXAMPLE",
+        secret_key="wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
+        secure=True,
+        region="us-east-1",
+    )
+    print(f"Created bucket secret: {bucket_secret}")
+
+    # List all bucket secrets
+    secrets = await luml.bucket_secrets.list()
+    print(f"Bucket secrets: {secrets}")
+
+    # Get bucket secret by name
+    secret = await luml.bucket_secrets.get("my-ml-models-bucket")
+    print(f"Bucket secret by name: {secret}")
+
+    # Get bucket secret by id
+    secret = await luml.bucket_secrets.get("0199c455-21ed-7aba-9fe5-5231611220de")
+    print(f"Bucket secret by id: {secret}")
+
+    # Update bucket secret
+    updated_secret = await luml.bucket_secrets.update(
+        secret_id=bucket_secret.id, secure=False, region="us-west-2"
+    )
+    print(f"Updated bucket secret: {updated_secret}")
+
+    # Delete bucket secret
+    await luml.bucket_secrets.delete("0199c455-21ed-7aba-9fe5-5231611220de")
+
+
+async def demo_orbits() -> None:
+    # Create a new orbit
+    orbit = await luml.orbits.create(
+        name="ML Production Orbit",
+        bucket_secret_id="0199c455-21ed-7aba-9fe5-5231611220de",
+    )
+    print(f"Created orbit: {orbit}")
+
+    # Get Orbit by name
+    orbit_by_name = await luml.orbits.get("ML Production Orbit")
+    print(f"Orbit by name: {orbit_by_name}")
+
+    # Get Orbit by id
+    orbit_by_id = await luml.orbits.get("0199c455-21ed-7aba-9fe5-5231611220de")
+    print(f"Orbit by id: {orbit_by_id}")
+
+    # List all orbits
+    orbits = await luml.orbits.list()
+    print(f"Orbits: {orbits}")
+
+    # Update orbit
+    updated_orbit = await luml.orbits.update(name="ML Production Environment")
+    print(f"Updated orbit: {updated_orbit}")
+
+    # Delete Orbit
+    await luml.orbits.delete("0199c455-21ed-7aba-9fe5-5231611220de")
+
+
+async def demo_collections() -> None:
+    # Create a model collection
+    collection = await luml.collections.create(
+        name="Production Models",
+        description="Trained models ready for production deployment",
+        type=CollectionType.MODEL,
+        tags=["production", "ml", "models"],
+    )
+    print(f"Created collection: {collection}")
+
+    # Get default collection
+    default_collection = await luml.collections.get()
+    print(f"Get Default Collection Details: {default_collection}")
+
+    # Get collection by name
+    collection_by_name = await luml.collections.get("Production Models")
+    print(f"Collection by name: {collection_by_name}")
+
+    # Get collection by id
+    collection_by_id = await luml.collections.get(
+        "0199c455-21ee-74c6-b747-19a82f1a1e75"
+    )
+    print(f"Collection by id: {collection_by_id}")
+
+    # List all collections in the orbit
+    collections = await luml.collections.list()
+    print(f"Collection: {collections}")
+
+    # Update collection with new tags
+    updated_collection = await luml.collections.update(
+        collection_id="0199c455-21ee-74c6-b747-19a82f1a1e75",
+        description="Updated: Production-ready ML models",
+    )
+    print(f"Updated collection: {updated_collection}")
+
+    # Delete collection
+    await luml.collections.delete("0199c455-21ee-74c6-b747-19a82f1a1e75")
+
+
+async def demo_artifacts() -> None:
+    # Create new model artifact record with upload URL
+    model_created = await luml.artifacts.create(
+        file_name="customer_churn_model.fnnx",
+        extra_values={"accuracy": 0.95, "precision": 0.92, "recall": 0.88},
+        manifest={"version": "1.0", "framework": "xgboost"},
+        file_hash="abc123def456",
+        file_index={"layer1": (0, 1024), "layer2": (1024, 2048)},
+        size=1048576,
+        name="Customer Churn Predictor",
+        description="XGBoost model predicting customer churn probability",
+        tags=["xgboost", "churn", "production"],
+    )
+    print(f"Created model: {model_created}")
+
+    # List all model artifacts in the collection
+    models = await luml.artifacts.list()
+    print(f"All models in collection: {models}")
+
+    # Get model by ID
+    artifact_by_id = await luml.artifacts.get("0199c455-21ee-74c6-b747-19a82f1a1e75")
+    print(f"Artifact by id: {artifact_by_id}")
+
+    # Get model by name
+    artifact_by_name = await luml.artifacts.get("Customer Churn Predictor")
+    print(f"Artifact by name: {artifact_by_name}")
+
+    # Get model from specific collection
+    artifact_by_id_collection = await luml.artifacts.get(
+        "0199c455-21ee-74c6-b747-19a82f1a1e75",
+        collection_id="0199c455-21ee-74c6-b747-19a82f1a1e75",
+    )
+    print(f"Artifact by id: {artifact_by_id_collection}")
+
+    # Update model metadata
+    updated_model = await luml.artifacts.update(
+        artifact_id="0199c455-21ee-74c6-b747-19a82f1a1e75",
+        description="Updated: Advanced churn prediction model",
+        tags=["xgboost", "churn", "production", "v2.1"],
+        status=ModelArtifactStatus.UPLOADED,
+    )
+    print(f"Updated artifact: {updated_model}")
+
+    # Get download URL
+    download_url = await luml.artifacts.download_url(
+        "0199c455-21ee-74c6-b747-19a82f1a1e75"
+    )
+    print(f"Artifact Download URL: {download_url}")
+
+    # Get delete URL
+    delete_url = await luml.artifacts.delete_url("0199c455-21ee-74c6-b747-19a82f1a1e75")
+    print(f"Artifact Delete URL: {delete_url}")
+
+    # Upload a model file (example - file should exist)
+    uploaded_model = await luml.artifacts.upload(
+        file_path="/path/to/your/model.dfs",
+        model_name="Customer Churn Predictor",
+        description="XGBoost model predicting customer churn probability",
+        tags=["xgboost", "churn", "production"],
+    )
+    print(f"Uploaded artifact: {uploaded_model}")
+
+    # Download model
+    await luml.artifacts.download("0199c455-21ee-74c6-b747-19a82f1a1e75", "output.dfs")
+
+    # Delete model permanently
+    await luml.artifacts.delete("0199c455-21ee-74c6-b747-19a82f1a1e75")
+
+
+async def async_main() -> None:
+    print("\n--------------------------------\n")
+    await demo_client_defaults()
+    print("\n--------------------------------\n")
+    await demo_organizations()
+    print("\n--------------------------------\n")
+    await demo_bucket_secrets()
+    print("\n--------------------------------\n")
+    await demo_orbits()
+    print("\n--------------------------------\n")
+    await demo_collections()
+    print("\n--------------------------------\n")
+    await demo_artifacts()
+
+
+if __name__ == "__main__":
+    asyncio.run(async_main())

luml_api-0.1.0rc0/examples/demo.py

@@ -0,0 +1,242 @@
+from luml_api import LumlClient
+from luml_api._types import ArtifactStatus, CollectionType
+
+# Will use LUML API Production url "https://api.luml.ai"
+# And search for LUML_API_KEY in .env
+luml_simple = LumlClient()
+
+# No default organization, orbit and collection are set
+luml_without_defaults = LumlClient(api_key="luml_your_api_key_here")
+
+# Recommended initialization with default resources.
+# Resources initialized by their names
+luml_with_defaults_names = LumlClient(
+    api_key="luml_your_api_key_here",
+    organization="My Organization",
+    orbit="Default Orbit",
+    collection="Default Collection",
+)
+
+# Recommended initialization with default resources.
+# Resources initialized by their ids
+luml = LumlClient(
+    api_key="luml_your_api_key_here",
+    organization="0199c455-21ec-7c74-8efe-41470e29bae5",
+    orbit="0199c455-21ed-7aba-9fe5-5231611220de",
+    collection="0199c455-21ee-74c6-b747-19a82f1a1e75",
+)
+
+
+def demo_client_defaults() -> None:
+    # Get client defaults ids
+    default_organization_id = luml.organization
+    default_orbit_id = luml.orbit
+    default_collection_id = luml.collection
+
+    print(default_organization_id, default_orbit_id, default_collection_id)
+
+    # Set default resources
+    luml.organization = "0199c455-21ec-7c74-8efe-41470e29bae5"
+    luml.orbit = "0199c455-21ed-7aba-9fe5-5231611220de"
+    luml.collection = "0199c455-21ee-74c6-b747-19a82f1a1e75"
+
+    print(luml.organization, luml.orbit, luml.collection)
+
+
+def demo_organizations() -> None:
+    # List all available organization for user
+    all_my_organization = luml.organizations.list()
+    print(f"All user organization: {all_my_organization}")
+
+    # Get default organization
+    default_org_details = luml.organizations.get()
+    print(f"Default organization: {default_org_details}")
+
+    # Get organization by name
+    organization_by_name = luml.organizations.get("My Organization")
+    print(f"Organization by name: {organization_by_name}")
+
+    # Get organization by id
+    organization_by_id = luml.organizations.get("0199c455-21ec-7c74-8efe-41470e29bae5")
+    print(f"Organization by id: {organization_by_id}")
+
+
+def demo_bucket_secrets() -> None:
+    # Create a new bucket secret
+    bucket_secret = luml.bucket_secrets.create(
+        endpoint="s3.amazonaws.com",
+        bucket_name="my-ml-artifacts-bucket",
+        access_key="AKIAIOSFODNN7EXAMPLE",
+        secret_key="wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
+        secure=True,
+        region="us-east-1",
+    )
+    print(f"Created bucket secret: {bucket_secret}")
+
+    # List all bucket secrets
+    secrets = luml.bucket_secrets.list()
+    print(f"Bucket secrets: {secrets}")
+
+    # Get bucket secret by name
+    secret = luml.bucket_secrets.get("my-ml-artifacts-bucket")
+    print(f"Bucket secret by name: {secret}")
+
+    # Get bucket secret by id
+    secret = luml.bucket_secrets.get("0199c455-21ed-7aba-9fe5-5231611220de")
+    print(f"Bucket secret by id: {secret}")
+
+    # Update bucket secret
+    updated_secret = luml.bucket_secrets.update(
+        secret_id=bucket_secret.id, secure=False, region="us-west-2"
+    )
+    print(f"Updated bucket secret: {updated_secret}")
+
+    # Delete bucket secret
+    luml.bucket_secrets.delete("0199c455-21ed-7aba-9fe5-5231611220de")
+
+
+def demo_orbits() -> None:
+    # Create a new orbit
+    orbit = luml.orbits.create(
+        name="ML Production Orbit",
+        bucket_secret_id="0199c455-21ed-7aba-9fe5-5231611220de",
+    )
+    print(f"Created orbit: {orbit}")
+
+    # Get Orbit by name
+    orbit_by_name = luml.orbits.get("ML Production Orbit")
+    print(f"Orbit by name: {orbit_by_name}")
+
+    # Get Orbit by id
+    orbit_by_id = luml.orbits.get("0199c455-21ed-7aba-9fe5-5231611220de")
+    print(f"Orbit by id: {orbit_by_id}")
+
+    # List all orbits
+    orbits = luml.orbits.list()
+    print(f"Orbits: {orbits}")
+
+    # Update orbit
+    updated_orbit = luml.orbits.update(name="ML Production Environment")
+    print(f"Updated orbit: {updated_orbit}")
+
+    # Delete Orbit
+    luml.orbits.delete("0199c455-21ed-7aba-9fe5-5231611220de")
+
+
+def demo_collections() -> None:
+    # Create a artifact collection
+    collection = luml.collections.create(
+        name="Production artifacts",
+        description="Trained artifacts ready for production deployment",
+        type=CollectionType.MODEL,
+        tags=["production", "ml", "artifacts"],
+    )
+    print(f"Created collection: {collection}")
+
+    # Get default collection
+    default_collection = luml.collections.get()
+    print(f"Get Default Collection Details: {default_collection}")
+
+    # Get collection by name
+    collection_by_name = luml.collections.get("Production artifacts")
+    print(f"Collection by name: {collection_by_name}")
+
+    # Get collection by id
+    collection_by_id = luml.collections.get("0199c455-21ee-74c6-b747-19a82f1a1e75")
+    print(f"Collection by id: {collection_by_id}")
+
+    # List all collections in the orbit
+    collections = luml.collections.list()
+    print(f"Collection: {collections}")
+
+    # Update collection with new tags
+    updated_collection = luml.collections.update(
+        collection_id="0199c455-21ee-74c6-b747-19a82f1a1e75",
+        description="Updated: Production-ready ML artifacts",
+    )
+    print(f"Updated collection: {updated_collection}")
+
+    # Delete collection
+    luml.collections.delete("0199c455-21ee-74c6-b747-19a82f1a1e75")
+
+
+def demo_artifacts() -> None:
+    # Create new artifact artifact record with upload URL
+    artifact_created = luml.artifacts.create(
+        file_name="customer_churn_artifact.fnnx",
+        extra_values={"accuracy": 0.95, "precision": 0.92, "recall": 0.88},
+        manifest={"version": "1.0", "framework": "xgboost"},
+        file_hash="abc123def456",
+        file_index={"layer1": (0, 1024), "layer2": (1024, 2048)},
+        size=1048576,
+        name="Customer Churn Predictor",
+        description="XGBoost artifact predicting customer churn probability",
+        tags=["xgboost", "churn", "production"],
+    )
+    print(f"Created artifact: {artifact_created}")
+
+    # List all artifact artifacts in the collection
+    artifacts = luml.artifacts.list()
+    print(f"All artifacts in collection: {artifacts}")
+
+    # Get artifact by ID
+    artifact_by_id = luml.artifacts.get("0199c455-21ee-74c6-b747-19a82f1a1e75")
+    print(f"artifact by id: {artifact_by_id}")
+
+    # Get artifact by name
+    artifact_by_name = luml.artifacts.get("Customer Churn Predictor")
+    print(f"artifact by name: {artifact_by_name}")
+
+    # Get artifact from specific collection
+    artifact_by_id_collection = luml.artifacts.get(
+        "0199c455-21ee-74c6-b747-19a82f1a1e75",
+        collection_id="0199c455-21ee-74c6-b747-19a82f1a1e75",
+    )
+    print(f"artifact by id: {artifact_by_id_collection}")
+
+    # Update artifact metadata
+    updated_artifact = luml.artifacts.update(
+        artifact_id="0199c455-21ee-74c6-b747-19a82f1a1e75",
+        description="Updated: Advanced churn prediction artifact",
+        tags=["xgboost", "churn", "production", "v2.1"],
+        status=ArtifactStatus.UPLOADED,
+    )
+    print(f"Updated artifact: {updated_artifact}")
+
+    # Get download URL
+    download_url = luml.artifacts.download_url("0199c455-21ee-74c6-b747-19a82f1a1e75")
+    print(f"artifact Download URL: {download_url}")
+
+    # Get delete URL
+    delete_url = luml.artifacts.delete_url("0199c455-21ee-74c6-b747-19a82f1a1e75")
+    print(f"artifact Delete URL: {delete_url}")
+
+    # Upload a artifact file (example - file should exist)
+    uploaded_artifact = luml.artifacts.upload(
+        file_path="/path/to/your/artifact.dfs",
+        name="Customer Churn Predictor",
+        description="XGBoost artifact predicting customer churn probability",
+        tags=["xgboost", "churn", "production"],
+    )
+    print(f"Uploaded artifact: {uploaded_artifact}")
+
+    # Download artifact
+    luml.artifacts.download("0199c455-21ee-74c6-b747-19a82f1a1e75", "output.dfs")
+
+    # Delete artifact permanently
+    luml.artifacts.delete("0199c455-21ee-74c6-b747-19a82f1a1e75")
+
+
+if __name__ == "__main__":
+    print("\n--------------------------------\n")
+    demo_client_defaults()
+    print("\n--------------------------------\n")
+    demo_organizations()
+    print("\n--------------------------------\n")
+    demo_bucket_secrets()
+    print("\n--------------------------------\n")
+    demo_orbits()
+    print("\n--------------------------------\n")
+    demo_collections()
+    print("\n--------------------------------\n")
+    demo_artifacts()

luml_api-0.1.0rc0/luml_api/__init__.py

@@ -0,0 +1,51 @@
+__version__ = "0.1.0rc0"
+__title__ = "luml-sdk"
+
+from luml_api._client import AsyncLumlClient, LumlClient
+from luml_api._exceptions import (
+    APIError,
+    APIResponseValidationError,
+    APIStatusError,
+    AuthenticationError,
+    BadRequestError,
+    ConflictError,
+    InternalServerError,
+    LumlAPIError,
+    NotFoundError,
+    PermissionDeniedError,
+    UnprocessableEntityError,
+)
+from luml_api._types import (
+    ArtifactSortBy,
+    ArtifactStatus,
+    ArtifactType,
+    CollectionSortBy,
+    CollectionType,
+    CollectionTypeFilter,
+    SortOrder,
+)
+
+__all__ = [
+    "__version__",
+    "__title__",
+    "LumlClient",
+    "AsyncLumlClient",
+    "LumlAPIError",
+    "APIError",
+    "APIResponseValidationError",
+    "APIStatusError",
+    "BadRequestError",
+    "AuthenticationError",
+    "PermissionDeniedError",
+    "NotFoundError",
+    "ConflictError",
+    "UnprocessableEntityError",
+    "InternalServerError",
+    "ArtifactSortBy",
+    "ArtifactStatus",
+    "ArtifactType",
+    "CollectionSortBy",
+    "CollectionType",
+    "CollectionTypeFilter",
+    "SortOrder",
+]