langflow-control-plane-sdk 0.0.0.dev0__py3-none-any.whl

langflow_control_plane_sdk/models/replace_deployment.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+    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
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from langflow_control_plane_sdk.models.flow_input import FlowInput
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class ReplaceDeployment(BaseModel):
+    """
+    ReplaceDeployment
+    """ # noqa: E501
+    description: Optional[Annotated[str, Field(strict=True, max_length=4096)]] = None
+    flows: List[FlowInput]
+    __properties: ClassVar[List[str]] = ["description", "flows"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of ReplaceDeployment from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in flows (list)
+        _items = []
+        if self.flows:
+            for _item_flows in self.flows:
+                if _item_flows:
+                    _items.append(_item_flows.to_dict())
+            _dict['flows'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ReplaceDeployment from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "description": obj.get("description"),
+            "flows": [FlowInput.from_dict(_item) for _item in obj["flows"]] if obj.get("flows") is not None else None
+        })
+        return _obj
+
+

langflow_control_plane_sdk/rest.py

@@ -0,0 +1,201 @@
+# coding: utf-8
+
+"""
+    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
+
+
+import io
+import json
+import re
+import ssl
+from typing import Optional, Union
+
+import httpx
+
+from langflow_control_plane_sdk.exceptions import ApiException, ApiValueError
+
+RESTResponseType = httpx.Response
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp) -> None:
+        self.response = resp
+        self.status = resp.status_code
+        self.reason = resp.reason_phrase
+        self.data = None
+
+    async def read(self):
+        if self.data is None:
+            self.data = await self.response.aread()
+        return self.data
+
+    @property
+    def headers(self):
+        """Returns a CIMultiDictProxy of response headers."""
+        return self.response.headers
+
+    def getheaders(self):
+        """Returns a CIMultiDictProxy of the response headers; use ``headers`` instead."""
+        return self.response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header; use ``headers`` instead."""
+        return self.response.headers.get(name, default)
+
+
+class RESTClientObject:
+
+    def __init__(self, configuration) -> None:
+
+        # maxsize is number of requests to host that are allowed in parallel
+        self.maxsize = configuration.connection_pool_maxsize
+
+        self.ssl_context = ssl.create_default_context(
+            cafile=configuration.ssl_ca_cert,
+            cadata=configuration.ca_cert_data,
+        )
+        if configuration.cert_file:
+            self.ssl_context.load_cert_chain(
+                configuration.cert_file, keyfile=configuration.key_file
+            )
+
+        if not configuration.verify_ssl:
+            self.ssl_context.check_hostname = False
+            self.ssl_context.verify_mode = ssl.CERT_NONE
+
+        self.proxy = configuration.proxy
+        self.proxy_headers = configuration.proxy_headers
+
+        self.pool_manager: Optional[httpx.AsyncClient] = None
+
+    async def close(self):
+        if self.pool_manager is not None:
+            await self.pool_manager.aclose()
+
+    async def request(
+            self,
+            method,
+            url,
+            headers=None,
+            body=None,
+            post_params=None,
+            _request_timeout=None):
+        """Execute request
+
+        :param method: http request method
+        :param url: http request url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        assert method in [
+            'GET',
+            'HEAD',
+            'DELETE',
+            'POST',
+            'PUT',
+            'PATCH',
+            'OPTIONS'
+        ]
+
+        if post_params and body:
+            raise ApiValueError(
+                "body parameter cannot be used with post_params parameter."
+            )
+
+        post_params = post_params or {}
+        headers = headers or {}
+        timeout = _request_timeout or 5 * 60
+
+        if 'Content-Type' not in headers:
+            headers['Content-Type'] = 'application/json'
+
+        args = {
+            "method": method,
+            "url": url,
+            "timeout": timeout,
+            "headers": headers
+        }
+
+        # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+        if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+            if re.search('json', headers['Content-Type'], re.IGNORECASE):
+                if body is not None:
+                    args["json"] = body
+                if body is None and post_params:
+                    args["json"] = dict(post_params)
+            elif headers['Content-Type'] == 'application/x-www-form-urlencoded':  # noqa: E501
+                args["data"] = dict(post_params)
+            elif headers['Content-Type'] == 'multipart/form-data':
+                # must del headers['Content-Type'], or the correct
+                # Content-Type which generated by httpx
+                del headers['Content-Type']
+
+                files = []
+                data = {}
+                for param in post_params:
+                    k, v = param
+                    if isinstance(v, tuple) and len(v) == 3:
+                        files.append((k, v))
+                    else:
+                        # Ensures that dict objects are serialized
+                        if isinstance(v, dict):
+                            v = json.dumps(v)
+                        elif isinstance(v, int):
+                            v = str(v)
+                        data[k] = v
+
+                if files:
+                    args["files"] = files
+                if data:
+                    args["data"] = data
+
+            # Pass a `bytes` parameter directly in the body to support
+            # other content types than Json when `body` argument is provided
+            # in serialized form
+            elif isinstance(body, str) or isinstance(body, bytes):
+                args["data"] = body
+            else:
+                # Cannot generate the request from given parameters
+                msg = """Cannot prepare a request message for provided
+                         arguments. Please check that your arguments match
+                         declared content type."""
+                raise ApiException(status=0, reason=msg)
+
+        if self.pool_manager is None:
+            self.pool_manager = self._create_pool_manager()
+
+        r = await self.pool_manager.request(**args)
+        return RESTResponse(r)
+
+    def _create_pool_manager(self) -> httpx.AsyncClient:
+        limits = httpx.Limits(max_connections=self.maxsize)
+
+        proxy = None
+        if self.proxy:
+            proxy = httpx.Proxy(
+                url=self.proxy,
+                headers=self.proxy_headers
+            )
+
+        return httpx.AsyncClient(
+            limits=limits,
+            proxy=proxy,
+            verify=self.ssl_context,
+            trust_env=True
+        )

langflow_control_plane_sdk-0.0.0.dev0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,26 @@
+langflow_control_plane_sdk/__init__.py,sha256=w8XBMoY2_V6biYKsZTsJj5I5evmXLG3k10hSPlyzlP0,2845
+langflow_control_plane_sdk/api_client.py,sha256=FFEak74MSCFyGI-V760fptbdOHUnt55rZnpsrsBr6xU,28917
+langflow_control_plane_sdk/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
+langflow_control_plane_sdk/configuration.py,sha256=u7FIOs7jg1QPrHGl6hG5xmBSR2Q8HjwK15trsibEL6E,20321
+langflow_control_plane_sdk/exceptions.py,sha256=SrdsCkdWyLZKEbGLRp9ybgsJGq803J2EYC6Y0RqrUTQ,6469
+langflow_control_plane_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+langflow_control_plane_sdk/rest.py,sha256=cw8VYrkfzq7fiZn28lxxt3DWEi7LXRjLfh_Zy5ZiSfc,6547
+langflow_control_plane_sdk/api/__init__.py,sha256=MzMhMOjURPZZjtPRM_MRk0Curcm5PBbxi-rvQTNiweE,122
+langflow_control_plane_sdk/api/deployments_api.py,sha256=9zKL7uYcLkg6O67HP-jbvMckgJ4F3ytu3fVO7f3AAnk,70494
+langflow_control_plane_sdk/models/__init__.py,sha256=_vyxp8E1WN6Sp_5alSZOUd1_hnsFEz3YOu5TjqWAFGM,1229
+langflow_control_plane_sdk/models/create_deployment.py,sha256=i4wtp79czbVonRIfEY7lkTxdLBB5bA-ixQx1PMXHo18,3617
+langflow_control_plane_sdk/models/deployment_detail.py,sha256=6QmpU7iU3AZ8iYHlBQLSawXxOOE41YrmZtlZ-Hmmv9Q,3408
+langflow_control_plane_sdk/models/deployment_list.py,sha256=3nBvCblDNMNWoAK5Ar9Bdm3UAamRyL4zlvxrOO8KNoQ,3378
+langflow_control_plane_sdk/models/deployment_list_item.py,sha256=fpkjBFnnamgXbhDVuZAR8fGfv059kS4jSEcDG3vcAmM,3306
+langflow_control_plane_sdk/models/error_body.py,sha256=K0BAV61il3RtUQeNlNTfgv6Ru51jh-cBzZRSPneOoWA,2844
+langflow_control_plane_sdk/models/error_code.py,sha256=ioxG9JrArgG0IVhXUsyk4eo7CTY7xr07wTluSMWkYdk,1693
+langflow_control_plane_sdk/models/error_envelope.py,sha256=uxyBsf7zVfx0kpEv68QRFO_rDquXjE69SYpkSme3X-A,2689
+langflow_control_plane_sdk/models/flow_input.py,sha256=2LgtjFrdjmDZMpMk5wAQJhuVF4tqU2YWHV3m7oUWU8M,3563
+langflow_control_plane_sdk/models/flow_payload.py,sha256=uFup06TVWs9Ydzhsf8XtMFycqm0gZUiULdPi7Vt9n_E,3402
+langflow_control_plane_sdk/models/flow_payload_data.py,sha256=dVTbNm0vXXvGVkY7u-GOzBtJk0shg_kg0-3u6f0uIcU,3106
+langflow_control_plane_sdk/models/patch_deployment.py,sha256=hzJQ9sVH1DDdNcwI7ryMVRtJlbdPVQ_qPTB52FxwSlU,2527
+langflow_control_plane_sdk/models/replace_deployment.py,sha256=M0ftSbQ_JWYliWfWcE947kw30vB7ZE8CHJY9Jjhop6k,3105
+langflow_control_plane_sdk-0.0.0.dev0.dist-info/METADATA,sha256=TAEzk3Ix9xhwHrsWd4673S85CrSHJ1I0HVbABLS4AIw,4546
+langflow_control_plane_sdk-0.0.0.dev0.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+langflow_control_plane_sdk-0.0.0.dev0.dist-info/licenses/LICENSE,sha256=IyYhLpelP4l5uU9xaaGbKT6ipyNZI1okV4Yycrusv7A,1065
+langflow_control_plane_sdk-0.0.0.dev0.dist-info/RECORD,,

langflow_control_plane_sdk-0.0.0.dev0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.0
+Root-Is-Purelib: true
+Tag: py3-none-any

langflow_control_plane_sdk-0.0.0.dev0.dist-info/licenses/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.