langflow-control-plane-sdk 0.0.0.dev0__tar.gz

langflow_control_plane_sdk-0.0.0.dev0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Langflow
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

langflow_control_plane_sdk-0.0.0.dev0/PKG-INFO

@@ -0,0 +1,142 @@
+Metadata-Version: 2.5
+Name: langflow-control-plane-sdk
+Version: 0.0.0.dev0
+Summary: Generated async Python client for the Langflow Control Plane API
+License-Expression: MIT
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pydantic>=2.11
+Requires-Dist: python-dateutil>=2.8.2
+Requires-Dist: typing-extensions>=4.7.1
+Provides-Extra: test
+Requires-Dist: build>=1.2.2; extra == 'test'
+Requires-Dist: pytest-asyncio>=1.1.0; extra == 'test'
+Requires-Dist: pytest>=8.4.2; extra == 'test'
+Requires-Dist: pyyaml>=6.0.2; extra == 'test'
+Description-Content-Type: text/markdown
+
+# Langflow Control Plane Python SDK
+
+`langflow-control-plane-sdk` is the generated async Python 3.10+ client for the
+[Langflow Control Plane OpenAPI contract](../../api/openapi.yaml). The import
+package is `langflow_control_plane_sdk`, which is intentionally distinct from
+the `langflow-sdk` package for Langflow's main REST API.
+
+## Install
+
+```bash
+pip install langflow-control-plane-sdk
+```
+
+Normal installs select stable releases. Use
+`pip install --pre langflow-control-plane-sdk` to include development and
+release-candidate builds, or install an exact version such as
+`langflow-control-plane-sdk==0.1.0rc1`.
+
+## Configure
+
+Set the Control Plane base URL and its temporary pass-through `x-api-key`
+credential on the generated configuration:
+
+```python
+import langflow_control_plane_sdk as control_plane
+
+configuration = control_plane.Configuration(
+    host="https://control-plane.example",
+    api_key={"LangflowAPIKey": "replace-me"},
+)
+```
+
+The key is sent as `x-api-key`; do not log it. This pass-through authentication
+scheme is temporary. A future authentication change can affect SDK users and is
+therefore treated as semver-significant.
+
+## Async CRUD
+
+```python
+from uuid import uuid4
+
+import langflow_control_plane_sdk as control_plane
+
+flow_id = uuid4()
+flow = control_plane.FlowInput(
+    flow_id=flow_id,
+    author_flow_id=flow_id,
+    author_flow_version_id=uuid4(),
+    name="hello-world",
+    payload=control_plane.FlowPayload(
+        data=control_plane.FlowPayloadData(nodes=[], edges=[]),
+    ),
+)
+
+async with control_plane.ApiClient(configuration) as client:
+    deployments = control_plane.DeploymentsApi(client)
+    created = await deployments.create_deployment(
+        control_plane.CreateDeployment(slug="hello-world", flows=[flow]),
+    )
+    fetched = await deployments.get_deployment(created.id)
+    updated = await deployments.replace_deployment(
+        created.id,
+        control_plane.ReplaceDeployment(description="updated", flows=[flow]),
+    )
+    patched = await deployments.patch_deployment(
+        created.id,
+        control_plane.PatchDeployment(description="patched"),
+    )
+    await deployments.delete_deployment(created.id)
+```
+
+List responses always contain `next_cursor`; it is `None` on the last page.
+Pass a non-null cursor back unchanged:
+
+```python
+async with control_plane.ApiClient(configuration) as client:
+    deployments = control_plane.DeploymentsApi(client)
+    page = await deployments.list_deployments(limit=50)
+    while page.next_cursor is not None:
+        page = await deployments.list_deployments(
+            cursor=page.next_cursor,
+            limit=50,
+        )
+```
+
+Unsuccessful responses raise `ApiException`. For documented responses,
+`exception.data` is a typed `ErrorEnvelope`:
+
+```python
+try:
+    await deployments.get_deployment(deployment_id)
+except control_plane.ApiException as exception:
+    if isinstance(exception.data, control_plane.ErrorEnvelope):
+        print(exception.data.error.code, exception.data.error.message)
+    raise
+```
+
+## Regenerate and test
+
+Generation requires Python 3.10+, Java 11+, and the pinned generator. If Java
+is unavailable, `jdk4py` can optionally provide a local JVM.
+
+```bash
+make openapi-install
+make sdk-py-install
+make openapi-test
+make sdk-py-generate
+make sdk-py-test
+make sdk-py-build
+```
+
+When using `jdk4py`, install it in the codegen environment with
+`sdk/openapi-generator/.venv/bin/python -m pip install jdk4py`.
+
+Generated package files must not be edited by hand. Change `api/openapi.yaml`,
+the generator options in the root `Makefile`, or the templates, then
+regenerate them.
+
+The checked-in SDK uses the base version `0.0.0`. Release builds apply the exact
+`v`-prefixed Git tag version to a temporary build copy; the OpenAPI
+`info.version` independently identifies the API contract line.
+
+See the repository's [release guide](../../RELEASE.md) for shared service and
+SDK versioning and tag formats.

langflow_control_plane_sdk-0.0.0.dev0/README.md

@@ -0,0 +1,124 @@
+# Langflow Control Plane Python SDK
+
+`langflow-control-plane-sdk` is the generated async Python 3.10+ client for the
+[Langflow Control Plane OpenAPI contract](../../api/openapi.yaml). The import
+package is `langflow_control_plane_sdk`, which is intentionally distinct from
+the `langflow-sdk` package for Langflow's main REST API.
+
+## Install
+
+```bash
+pip install langflow-control-plane-sdk
+```
+
+Normal installs select stable releases. Use
+`pip install --pre langflow-control-plane-sdk` to include development and
+release-candidate builds, or install an exact version such as
+`langflow-control-plane-sdk==0.1.0rc1`.
+
+## Configure
+
+Set the Control Plane base URL and its temporary pass-through `x-api-key`
+credential on the generated configuration:
+
+```python
+import langflow_control_plane_sdk as control_plane
+
+configuration = control_plane.Configuration(
+    host="https://control-plane.example",
+    api_key={"LangflowAPIKey": "replace-me"},
+)
+```
+
+The key is sent as `x-api-key`; do not log it. This pass-through authentication
+scheme is temporary. A future authentication change can affect SDK users and is
+therefore treated as semver-significant.
+
+## Async CRUD
+
+```python
+from uuid import uuid4
+
+import langflow_control_plane_sdk as control_plane
+
+flow_id = uuid4()
+flow = control_plane.FlowInput(
+    flow_id=flow_id,
+    author_flow_id=flow_id,
+    author_flow_version_id=uuid4(),
+    name="hello-world",
+    payload=control_plane.FlowPayload(
+        data=control_plane.FlowPayloadData(nodes=[], edges=[]),
+    ),
+)
+
+async with control_plane.ApiClient(configuration) as client:
+    deployments = control_plane.DeploymentsApi(client)
+    created = await deployments.create_deployment(
+        control_plane.CreateDeployment(slug="hello-world", flows=[flow]),
+    )
+    fetched = await deployments.get_deployment(created.id)
+    updated = await deployments.replace_deployment(
+        created.id,
+        control_plane.ReplaceDeployment(description="updated", flows=[flow]),
+    )
+    patched = await deployments.patch_deployment(
+        created.id,
+        control_plane.PatchDeployment(description="patched"),
+    )
+    await deployments.delete_deployment(created.id)
+```
+
+List responses always contain `next_cursor`; it is `None` on the last page.
+Pass a non-null cursor back unchanged:
+
+```python
+async with control_plane.ApiClient(configuration) as client:
+    deployments = control_plane.DeploymentsApi(client)
+    page = await deployments.list_deployments(limit=50)
+    while page.next_cursor is not None:
+        page = await deployments.list_deployments(
+            cursor=page.next_cursor,
+            limit=50,
+        )
+```
+
+Unsuccessful responses raise `ApiException`. For documented responses,
+`exception.data` is a typed `ErrorEnvelope`:
+
+```python
+try:
+    await deployments.get_deployment(deployment_id)
+except control_plane.ApiException as exception:
+    if isinstance(exception.data, control_plane.ErrorEnvelope):
+        print(exception.data.error.code, exception.data.error.message)
+    raise
+```
+
+## Regenerate and test
+
+Generation requires Python 3.10+, Java 11+, and the pinned generator. If Java
+is unavailable, `jdk4py` can optionally provide a local JVM.
+
+```bash
+make openapi-install
+make sdk-py-install
+make openapi-test
+make sdk-py-generate
+make sdk-py-test
+make sdk-py-build
+```
+
+When using `jdk4py`, install it in the codegen environment with
+`sdk/openapi-generator/.venv/bin/python -m pip install jdk4py`.
+
+Generated package files must not be edited by hand. Change `api/openapi.yaml`,
+the generator options in the root `Makefile`, or the templates, then
+regenerate them.
+
+The checked-in SDK uses the base version `0.0.0`. Release builds apply the exact
+`v`-prefixed Git tag version to a temporary build copy; the OpenAPI
+`info.version` independently identifies the API contract line.
+
+See the repository's [release guide](../../RELEASE.md) for shared service and
+SDK versioning and tag formats.

langflow_control_plane_sdk-0.0.0.dev0/langflow_control_plane_sdk/__init__.py

@@ -0,0 +1,72 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    Langflow Control Plane API
+
+    Manage Langflow Runtime Deployments.
+
+    The version of the OpenAPI document: 0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+__version__ = "0.0.0.dev0"
+
+# Define package exports
+__all__ = [
+    "DeploymentsApi",
+    "ApiResponse",
+    "ApiClient",
+    "Configuration",
+    "OpenApiException",
+    "ApiTypeError",
+    "ApiValueError",
+    "ApiKeyError",
+    "ApiAttributeError",
+    "ApiException",
+    "CreateDeployment",
+    "DeploymentDetail",
+    "DeploymentList",
+    "DeploymentListItem",
+    "ErrorBody",
+    "ErrorCode",
+    "ErrorEnvelope",
+    "FlowInput",
+    "FlowPayload",
+    "FlowPayloadData",
+    "PatchDeployment",
+    "ReplaceDeployment",
+]
+
+# import apis into sdk package
+from langflow_control_plane_sdk.api.deployments_api import DeploymentsApi as DeploymentsApi
+
+# import ApiClient
+from langflow_control_plane_sdk.api_response import ApiResponse as ApiResponse
+from langflow_control_plane_sdk.api_client import ApiClient as ApiClient
+from langflow_control_plane_sdk.configuration import Configuration as Configuration
+from langflow_control_plane_sdk.exceptions import OpenApiException as OpenApiException
+from langflow_control_plane_sdk.exceptions import ApiTypeError as ApiTypeError
+from langflow_control_plane_sdk.exceptions import ApiValueError as ApiValueError
+from langflow_control_plane_sdk.exceptions import ApiKeyError as ApiKeyError
+from langflow_control_plane_sdk.exceptions import ApiAttributeError as ApiAttributeError
+from langflow_control_plane_sdk.exceptions import ApiException as ApiException
+
+# import models into sdk package
+from langflow_control_plane_sdk.models.create_deployment import CreateDeployment as CreateDeployment
+from langflow_control_plane_sdk.models.deployment_detail import DeploymentDetail as DeploymentDetail
+from langflow_control_plane_sdk.models.deployment_list import DeploymentList as DeploymentList
+from langflow_control_plane_sdk.models.deployment_list_item import DeploymentListItem as DeploymentListItem
+from langflow_control_plane_sdk.models.error_body import ErrorBody as ErrorBody
+from langflow_control_plane_sdk.models.error_code import ErrorCode as ErrorCode
+from langflow_control_plane_sdk.models.error_envelope import ErrorEnvelope as ErrorEnvelope
+from langflow_control_plane_sdk.models.flow_input import FlowInput as FlowInput
+from langflow_control_plane_sdk.models.flow_payload import FlowPayload as FlowPayload
+from langflow_control_plane_sdk.models.flow_payload_data import FlowPayloadData as FlowPayloadData
+from langflow_control_plane_sdk.models.patch_deployment import PatchDeployment as PatchDeployment
+from langflow_control_plane_sdk.models.replace_deployment import ReplaceDeployment as ReplaceDeployment
+

langflow_control_plane_sdk-0.0.0.dev0/langflow_control_plane_sdk/api/__init__.py

@@ -0,0 +1,5 @@
+# flake8: noqa
+
+# import apis into api package
+from langflow_control_plane_sdk.api.deployments_api import DeploymentsApi
+