bowire-plugin 0.3.0__py3-none-any.whl

bowire_plugin-0.3.0.dist-info/METADATA

@@ -0,0 +1,486 @@
+Metadata-Version: 2.5
+Name: bowire-plugin
+Version: 0.3.0
+Summary: Write a Bowire protocol plugin in Python — JSON-RPC sidecar SDK (stdio + HTTP/SSE).
+Project-URL: Homepage, https://bowire.io/
+Project-URL: Repository, https://github.com/Kuestenlogik/Bowire.Sdk.Python
+Project-URL: Sidecar spec, https://github.com/Kuestenlogik/Bowire/blob/main/docs/architecture/sidecar-plugins.md
+Author: Küstenlogik
+License:                                  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.
+License-File: LICENSE
+Keywords: bowire,developer-tools,json-rpc,plugin,protocol,sidecar
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff<0.18,>=0.16; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# bowire-plugin (Python SDK)
+
+[![PyPI](https://img.shields.io/pypi/v/bowire-plugin)](https://pypi.org/project/bowire-plugin/)
+[![Python](https://img.shields.io/pypi/pyversions/bowire-plugin)](https://pypi.org/project/bowire-plugin/)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
+
+Write a [Bowire](https://github.com/Kuestenlogik/Bowire) protocol plugin **in Python**.
+
+Bowire's first-party plugins are .NET assemblies, but any executable can be a plugin by speaking JSON-RPC 2.0 over its stdin/stdout — a *sidecar*. This SDK hides the wire: subclass `BowirePlugin`, implement the methods you need, call `run()`. Perfect when the best client for your protocol lives in the Python ecosystem (`paho-mqtt`, the SciPy/ML stack, vendor SDKs, …).
+
+See the full wire spec: [`docs/architecture/sidecar-plugins.md`](https://github.com/Kuestenlogik/Bowire/blob/main/docs/architecture/sidecar-plugins.md).
+
+## Install
+
+```bash
+pip install bowire-plugin
+```
+
+## Write a plugin
+
+```python
+from bowire_plugin import BowirePlugin, ServiceInfo, MethodInfo, InvokeResult, run
+
+class MyPlugin(BowirePlugin):
+    id = "myproto"          # must match sidecar.json's protocol.id
+    name = "MyProtocol"
+    icon_svg = "<svg/>"     # optional
+
+    def discover(self, server_url, show_internal, settings):
+        return [ServiceInfo("Things", methods=[
+            MethodInfo("get", full_name="Things/get", method_type="Unary"),
+        ])]
+
+    def invoke(self, server_url, service, method, json_messages, show_internal, metadata,
+               settings):
+        payload = json_messages[0] if json_messages else ""
+        return InvokeResult(response=f"got {payload}", status="OK")
+
+    def invoke_stream(self, server_url, service, method, json_messages, show_internal, metadata,
+                      settings):
+        for i in range(5):
+            yield f'{{"tick":{i}}}'   # each yield → a $/stream/data frame
+
+if __name__ == "__main__":
+    run(MyPlugin())
+```
+
+`run()` blocks, handling the contract (`initialize` / `discover` / `invoke` / `invokeStream` / `ping` / `shutdown`) until the host disconnects.
+
+## Settings
+
+A plugin declares settings once; Bowire renders them in its Settings dialog,
+under the plugin's own section (Bowire 2.8 or later). The values come back on
+every call as the `settings` argument.
+
+**Declare** them by overriding `settings()`:
+
+```python
+from bowire_plugin import PluginSetting, SettingOption
+
+class MyPlugin(BowirePlugin):
+    def settings(self):
+        return [
+            PluginSetting("probeWindow", "Probe window", type="number", default_value=5,
+                          description="Seconds to listen before answering discovery."),
+            PluginSetting("verbose", "Verbose", type="bool", default_value=False),
+            PluginSetting("mode", "Mode", type="select", default_value="fast", options=[
+                SettingOption("fast", "Fast"),
+                SettingOption("thorough", "Thorough"),
+            ]),
+        ]
+```
+
+`type` is `"bool"` (the default), `"string"`, `"number"` or `"select"`. A
+`select` needs `options`; declaring one without them raises `ValueError`.
+
+**Read** them from the `settings` argument every call receives:
+
+```python
+    def discover(self, server_url, show_internal, settings):
+        window = settings.get_float("probeWindow")   # 5.0 until somebody sets it
+        if settings.get_bool("verbose"):
+            ...
+        thorough = settings.get_str("mode") == "thorough"
+```
+
+What the accessors guarantee:
+
+- **Fresh per call.** The host sends the current values with each request, so
+  a changed setting applies from the next call — no restart. Read the
+  argument; don't copy it into the plugin at startup.
+- **Typed, with the declared default.** `get_str` / `get_bool` / `get_int` /
+  `get_float` parse the value the host sent (always a string on the wire) and
+  return the `default_value` you declared when the key is absent — the host
+  only sends keys somebody actually set. Pass `default=` to override it for
+  one read.
+- **A value that does not parse falls back** to the default, as the host's own
+  .NET accessors do: `get_bool` accepts `true` / `false` in any case,
+  `get_int` ASCII digits with an optional sign, `get_float` a finite decimal
+  with an optional exponent. A key with neither a usable value nor a default
+  raises `KeyError`.
+- `settings` is also a read-only mapping of exactly what the host sent:
+  `dict(settings)`, `"verbose" in settings`, `settings.get("mode")`.
+
+## Hand-entry form
+
+A user can call your plugin without discovery, from the workbench's freeform
+form or Compose, and only your plugin knows what such a call needs. Declare it
+in `manual_entry()`. The SDK sends it in the `initialize` reply, and the
+workbench renders a Compose form from it and offers exactly these method types
+in the freeform form (Bowire 2.11 or later).
+
+```python
+from bowire_plugin import ManualCallKind, ManualEntryForm, ManualField
+
+def manual_entry(self) -> ManualEntryForm:
+    return ManualEntryForm(
+        url_placeholder="mybroker://localhost:9000",
+        call_kinds=[
+            ManualCallKind("produce", "Unary", label="Produce", service="{topic}", method="produce"),
+            ManualCallKind("consume", "ServerStreaming", label="Consume", service="{topic}", method="consume"),
+        ],
+        fields=[
+            ManualField("topic", label="Topic", placement="template", required=True),
+            ManualField("key", label="Key", call_kinds=["produce"]),
+        ],
+    )
+```
+
+- A **call kind** names how it runs: `Unary` is `invoke`, `ServerStreaming`
+  is `invoke_stream`, and `ClientStreaming` or `Duplex` opens a channel.
+  `service` and `method` are templates, in which `{key}` is the value of the
+  field with that key.
+- A **field** with `placement="template"` only feeds the templates. The
+  default, `"metadata"`, goes into the call's metadata under its `key`, which
+  is where your `invoke` reads it.
+- A form the host would refuse raises `ValueError` where it is built, naming
+  the problem. Examples are an unknown method type, a placeholder no field
+  declares, and a `select` without options. `manual_entry_problems(form)`
+  runs the same check.
+
+## Ship it
+
+Put the script next to a `sidecar.json` manifest:
+
+```json
+{
+  "packageId": "Acme.Bowire.Sidecar.MyProto",
+  "protocol": { "id": "myproto", "name": "MyProtocol" },
+  "executable": "python",
+  "args": ["my_plugin.py"],
+  "version": "1.0.0"
+}
+```
+
+The manifest names the interpreter and passes the script as its argument, so
+the script needs no shebang and no executable bit. The host first looks for
+`executable` in the plugin directory, then — for a bare name — on `PATH`
+(Bowire 2.8 or later). The SDK has to be installed into the interpreter that
+name resolves to.
+
+Why `python` and not `python3`: no single name exists on every machine, and
+`python` is the one that does wherever this SDK is installed in practice.
+
+| Where the plugin runs | `python` | `python3` |
+|---|---|---|
+| Windows, python.org installer or `actions/setup-python` | yes | no — resolves to the Microsoft Store alias, which exits without running anything |
+| Any virtual environment (`venv` on PATH), Linux, macOS or Windows | yes | Linux / macOS only — a Windows venv has no `python3.exe` |
+| Linux / macOS system interpreter, no venv | only where the distribution ships it (`python-is-python3`) | yes |
+
+The last row is also the one where `pip install bowire-plugin` is refused by
+default on current distributions (PEP 668), so a plugin there already needs a
+venv. If you ship a plugin only for Linux or macOS system interpreters, name
+`python3` instead.
+
+Zip the folder and install into Bowire:
+
+```bash
+bowire plugin install --file my-proto-sidecar.zip
+bowire --url myproto://your-server
+```
+
+`bowire plugin list` tags it `[sidecar: myproto]`.
+
+## Transports: stdio (default) or HTTP/SSE
+
+The same `BowirePlugin` runs over either wire — like MCP's stdio +
+streamable-HTTP. Default is stdio (the examples above). For a
+long-running / remote service, serve it over HTTP instead:
+
+```python
+from bowire_plugin import run_http
+run_http(MyPlugin(), host="127.0.0.1", port=8770)
+```
+
+`run_http` exposes one path: `POST` for JSON-RPC requests (the response
+body is the reply), `GET` as the SSE stream that carries server
+notifications (`$/stream/data`, …). Point the manifest at it with
+`transport: "http"`:
+
+```json
+{
+  "packageId": "Acme.Bowire.Sidecar.MyProto",
+  "protocol": { "id": "myproto", "name": "MyProtocol" },
+  "transport": "http",
+  "url": "http://127.0.0.1:8770/"
+}
+```
+
+| | stdio | http |
+|---|---|---|
+| Lifecycle | Bowire spawns/kills the process | you run the service; Bowire is just a client |
+| Best for | local plugin shipped as a zip | hosted / remote / shared by many hosts |
+| Deps | none | none (stdlib `http.server`) |
+
+## API surface
+
+| Override | When it's called | Return |
+|----------|------------------|--------|
+| `discover(server_url, show_internal, settings)` | discovery | `list[ServiceInfo]` (empty = decline the URL) |
+| `invoke(server_url, service, method, json_messages, show_internal, metadata, settings)` | unary call | `InvokeResult` |
+| `invoke_stream(...)` | server-streaming call | iterator of JSON strings (each → one frame) |
+| `settings()` | once, for the `initialize` reply | `list[PluginSetting]` |
+| `manual_entry()` | for the `initialize` reply | `ManualEntryForm`, or `None` for no form |
+| `shutdown()` | host exit | `None` (cleanup hook) |
+
+Class attributes: `id` (required, matches the manifest), `name`, `icon_svg`.
+
+Models — `ServiceInfo`, `MethodInfo`, `MessageInfo`, `FieldInfo`, `InvokeResult`, `PluginSetting`, `SettingOption`, `ManualEntryForm`, `ManualCallKind`, `ManualField` — are dataclasses that serialize to the camelCase shapes the host expects. `Settings` is the per-call argument described under [Settings](#settings).
+
+## Example
+
+[`examples/echo`](examples/echo) is a runnable plugin (unary echo + a ticker stream) that declares and reads three settings: a reply `prefix` (string), a `letterCase` (select) and the ticker length `ticks` (number). Smoke-test it as a plain process:
+
+```bash
+echo '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{}}' | python examples/echo/echo_plugin.py
+```
+
+Or install it into a real Bowire host, discover through it, and round-trip its settings through the workbench — what CI runs on Linux and Windows:
+
+```bash
+python scripts/e2e.py --bowire "$(command -v bowire)" --work "$(mktemp -d)"
+```
+
+## Releasing
+
+Pushing a tag `vX.Y.Z` that matches `version` in `pyproject.toml` publishes
+`bowire-plugin` to PyPI (`.github/workflows/release.yml`). The workflow tests
+that commit, builds the sdist and the wheel, and uploads them through PyPI
+Trusted Publishing from the `pypi` environment, so no API token is stored. A
+version already on PyPI is skipped. To publish an existing tag again, run the
+workflow by hand with that tag.
+
+## Not in scope
+
+Sidecars implement **protocols**, not host extensions (auth providers, UI widgets, mock emitters stay .NET). Full duplex channels (`open_channel`) are on the roadmap; today expose long-lived streams via `invoke_stream`.
+
+## License
+
+Apache-2.0.

bowire_plugin-0.3.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+bowire_plugin/__init__.py,sha256=C6y5s9C3NeTTsukJZ6bE-FA6_YZfzV3FnM6iUyaT6lg,1832
+bowire_plugin/_http.py,sha256=0kwNM6dIikr4b7unABl403fJYBRE8EIEbbV1KjSeEtM,5034
+bowire_plugin/_manual_entry.py,sha256=JAsRKjmGIVoH4RSn2FM_eXJsoLJnBUzgGqy_vVK8zLw,5642
+bowire_plugin/_models.py,sha256=aGWpqIpF9sJIzENbE9X16LT0tYJ5UxDihXKZZmQQvEk,5997
+bowire_plugin/_plugin.py,sha256=OPoqHOb7QmUKWZ7WQ-27KZkAxDgY2c494Fi09EqYFXU,3414
+bowire_plugin/_runtime.py,sha256=hN62Mz0X7XGZkPotRoYPekdsDI3PlIcOTN2aAfQG2o4,10846
+bowire_plugin/_settings.py,sha256=fZE4LTHFoL4uJUJbpzl8IB4aOP9c2WUH19TRfKOPHwo,7491
+bowire_plugin-0.3.0.dist-info/METADATA,sha256=QBPmI47bCTJLZ1XnBinxawfDr_ZC-L1l5L3MbdW79y8,25311
+bowire_plugin-0.3.0.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+bowire_plugin-0.3.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+bowire_plugin-0.3.0.dist-info/RECORD,,

bowire_plugin-0.3.0.dist-info/WHEEL

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