diff --git a/Cargo.toml b/Cargo.toml index 42cdb4ac..1d978c75 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -99,7 +99,7 @@ paddler_cli = { version = "4.0.0", path = "paddler_cli" } paddler_client = { version = "4.0.0", path = "paddler_client" } paddler_download_manager = { version = "4.0.0", path = "paddler_download_manager" } paddler_messaging = { version = "4.0.0", path = "paddler_messaging" } -paddler_openai_response_format_validator = { version = "4.0.0", path = "paddler_openai_response_format_validator" } +paddler_openai_response_format_validator = { path = "paddler_openai_response_format_validator" } paddler_state_conversion = { version = "4.0.0", path = "paddler_state_conversion" } paddler_test_cluster_harness = { version = "4.0.0", path = "paddler_test_cluster_harness" } paddler_tests = { version = "4.0.0", path = "paddler_tests" } diff --git a/paddler_bootstrap/Cargo.toml b/paddler_bootstrap/Cargo.toml index e4974139..20da84f5 100644 --- a/paddler_bootstrap/Cargo.toml +++ b/paddler_bootstrap/Cargo.toml @@ -5,7 +5,9 @@ version.workspace = true edition.workspace = true authors.workspace = true description = "Shared service wiring for Paddler CLI and desktop app" +homepage.workspace = true license.workspace = true +repository.workspace = true [[test]] name = "integration" diff --git a/paddler_cli/Cargo.toml b/paddler_cli/Cargo.toml index c8639fb2..337d6b14 100644 --- a/paddler_cli/Cargo.toml +++ b/paddler_cli/Cargo.toml @@ -4,7 +4,9 @@ version.workspace = true edition.workspace = true authors.workspace = true description = "CLI binary for Paddler" +homepage.workspace = true license.workspace = true +repository.workspace = true [[bin]] name = "paddler" diff --git a/paddler_cli_tests/Cargo.toml b/paddler_cli_tests/Cargo.toml index fbd205eb..61d11232 100644 --- a/paddler_cli_tests/Cargo.toml +++ b/paddler_cli_tests/Cargo.toml @@ -6,6 +6,7 @@ description = "Subprocess-isolated multi-agent integration tests for Paddler" edition.workspace = true homepage.workspace = true license.workspace = true +publish = false repository.workspace = true version.workspace = true diff --git a/paddler_client_javascript/README.md b/paddler_client_javascript/README.md index 1f1e23d0..2099f0ca 100644 --- a/paddler_client_javascript/README.md +++ b/paddler_client_javascript/README.md @@ -15,7 +15,7 @@ npm install @intentee/paddler-client rxjs zod ### WebSocket inference (multiplexed, request-id-keyed) ```ts -import { inferenceSocketClient } from "@intentee/paddler-client"; +import { inferenceSocketClient } from "@intentee/paddler-client/inferenceSocketClient"; const webSocket = new WebSocket("ws://localhost:8061/api/v1/inference_socket"); @@ -45,7 +45,8 @@ continueConversation({ ### HTTP NDJSON streaming ```ts -import { streamHttpNdjson, InferenceServiceGenerateTokensResponseSchema } from "@intentee/paddler-client"; +import { streamHttpNdjson } from "@intentee/paddler-client/streamHttpNdjson"; +import { InferenceServiceGenerateTokensResponseSchema } from "@intentee/paddler-client/schemas/InferenceServiceGenerateTokensResponse"; const controller = new AbortController(); @@ -60,19 +61,22 @@ streamHttpNdjson({ ### SSE management stream ```ts -import { streamEventSource, AgentsResponseSchema, matchEventSourceUpdateState } from "@intentee/paddler-client"; +import { streamEventSource } from "@intentee/paddler-client/streamEventSource"; +import { AgentsResponseSchema } from "@intentee/paddler-client/schemas/AgentsResponse"; streamEventSource({ url: new URL("http://localhost:8062/api/v1/agents/stream"), schema: AgentsResponseSchema, }).subscribe((state) => { - matchEventSourceUpdateState(state, { - initial: () => console.log("connecting"), - connected: () => console.log("connected"), - dataSnapshot: ({ data }) => console.log("agents", data.agents.length), - connectionError: () => console.error("connection lost"), - deserializationError: () => console.error("invalid payload"), - }); + if (state.isOk) { + console.log("agents", state.data.agents.length); + } else if (state.isConnectionError) { + console.error("connection lost"); + } else if (state.isDeserializationError) { + console.error("invalid payload"); + } else if (state.isConnected) { + console.log("connected"); + } }); ``` diff --git a/paddler_client_python/LICENSE b/paddler_client_python/LICENSE new file mode 100644 index 00000000..261eeb9e --- /dev/null +++ b/paddler_client_python/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/paddler_client_python/README.md b/paddler_client_python/README.md new file mode 100644 index 00000000..983cc9d3 --- /dev/null +++ b/paddler_client_python/README.md @@ -0,0 +1,95 @@ +# paddler-client + +Python client for the [Paddler](https://github.com/intentee/paddler) LLM load balancer. + +## Install + +```sh +pip install paddler-client +``` + +Requires Python 3.11+. Built on `httpx`, `websockets`, and `pydantic` v2. + +## Quick start + +### WebSocket inference (multiplexed, request-id-keyed) + +```python +import asyncio + +from paddler_client import ClientInference +from paddler_client.continue_from_conversation_history_params import ( + ContinueFromConversationHistoryParams, +) +from paddler_client.conversation_message import ConversationMessage + + +async def main() -> None: + params = ContinueFromConversationHistoryParams( + add_generation_prompt=True, + conversation_history=[ + ConversationMessage(content="Say hello.", role="user"), + ], + enable_thinking=False, + max_tokens=128, + ) + + async with ClientInference(url="http://localhost:8061") as client: + stream = await client.continue_from_conversation_history(params) + + async for message in stream: + if message.is_token: + print(message.token, end="", flush=True) + elif message.is_terminal: + break + + +asyncio.run(main()) +``` + +### HTTP NDJSON streaming + +```python +async with ClientInference(url="http://localhost:8061") as client: + async for message in client.post_continue_from_conversation_history(params): + if message.is_token: + print(message.token, end="", flush=True) + elif message.is_terminal: + break +``` + +`ClientInference` also provides `continue_from_raw_prompt` and +`generate_embedding_batch`. + +### Management + +```python +from paddler_client import ClientManagement + + +async with ClientManagement(url="http://localhost:8062") as client: + snapshot = await client.get_agents() + + for agent in snapshot.agents: + print(agent.id, agent.slots_total) + + state = await client.get_balancer_desired_state() + await client.put_balancer_desired_state(state) + + metrics = await client.get_metrics() +``` + +`ClientManagement` also provides `agents_stream`, `get_buffered_requests`, +`buffered_requests_stream`, `get_chat_template_override`, and +`get_model_metadata`. + +## Coverage + +- Transport: WebSocket (multiplexed), HTTP NDJSON, HTTP JSON, Server-Sent Events +- Models: every Paddler wire-format type (validated via pydantic) +- Fully typed (`py.typed`), async-first API +- Specialized error types per failure mode + +## License + +Apache-2.0 diff --git a/paddler_client_python/pyproject.toml b/paddler_client_python/pyproject.toml index bb3fb5fb..6360b847 100644 --- a/paddler_client_python/pyproject.toml +++ b/paddler_client_python/pyproject.toml @@ -4,6 +4,7 @@ version = "4.0.0" description = "Python client for Paddler LLM load balancer" authors = ["Intentee"] license = "Apache-2.0" +readme = "README.md" homepage = "https://github.com/intentee/paddler" repository = "https://github.com/intentee/paddler" keywords = ["llm", "load-balancer", "inference", "paddler"] diff --git a/paddler_gui/Cargo.toml b/paddler_gui/Cargo.toml index 042ee2a9..1dc8ead4 100644 --- a/paddler_gui/Cargo.toml +++ b/paddler_gui/Cargo.toml @@ -4,7 +4,10 @@ version.workspace = true edition.workspace = true authors.workspace = true description = "Paddler desktop application" +homepage.workspace = true license.workspace = true +publish = false +repository.workspace = true [dependencies] actix-web = { workspace = true } diff --git a/paddler_openai_response_format_validator/Cargo.toml b/paddler_openai_response_format_validator/Cargo.toml index c45e5037..c03d206c 100644 --- a/paddler_openai_response_format_validator/Cargo.toml +++ b/paddler_openai_response_format_validator/Cargo.toml @@ -5,6 +5,7 @@ description.workspace = true edition.workspace = true homepage.workspace = true license.workspace = true +publish = false repository.workspace = true version.workspace = true diff --git a/paddler_test_cluster_harness/Cargo.toml b/paddler_test_cluster_harness/Cargo.toml index e97271e6..ffdbc28e 100644 --- a/paddler_test_cluster_harness/Cargo.toml +++ b/paddler_test_cluster_harness/Cargo.toml @@ -5,6 +5,7 @@ description = "Shared balancer-API-facing test harness for Paddler integration t edition.workspace = true homepage.workspace = true license.workspace = true +publish = false repository.workspace = true version.workspace = true diff --git a/paddler_tests/Cargo.toml b/paddler_tests/Cargo.toml index d1206be7..69229eba 100644 --- a/paddler_tests/Cargo.toml +++ b/paddler_tests/Cargo.toml @@ -6,6 +6,7 @@ description = "In-process integration tests for Paddler" edition.workspace = true homepage.workspace = true license.workspace = true +publish = false repository.workspace = true version.workspace = true