glowcap 0.1.1__tar.gz

glowcap-0.1.1/LICENSE-APACHE

@@ -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 2026 Glowcap LLC
+
+   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.

glowcap-0.1.1/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: glowcap
+Version: 0.1.1
+Summary: Python ctypes binding for the glowcap C ABI archives (codec-neutral CapTP core for OCapN).
+Author: Glowcap LLC
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/glowcap-org/glowcap
+Project-URL: Homepage, https://glowcap.org
+Project-URL: Documentation, https://glowcap.org
+Classifier: Development Status :: 3 - Alpha
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE-APACHE
+Provides-Extra: rendezvous
+Requires-Dist: websockets; extra == "rendezvous"
+Dynamic: license-file
+
+# Python binding
+
+This package lets Python connect to OCapN peers, call their objects, and host
+objects of its own. It uses `ctypes`, `asyncio`, and the standard library, and
+needs the CPython version `pyproject.toml` declares on an LP64 (64-bit Unix)
+platform. Terms such as locator, vat, and sturdyref are defined in the
+[glossary](../../docs/capabilities.md#glossary).
+
+```sh
+pip install glowcap
+```
+
+On first import the package downloads the C libraries of its version from the
+GitHub release and verifies them against its checksum file. Set
+`GLOWCAP_LIB_DIR` to an extracted C SDK's `lib/` directory to use a local copy.
+In a checkout of the repository, run `zig build` and make the tree's package
+importable instead:
+
+```sh
+export PYTHONPATH="$PWD/bindings/python${PYTHONPATH:+:$PYTHONPATH}"
+```
+
+```python
+import asyncio
+
+from glowcap import Runtime, tcp, VowBroken
+
+
+async def main():
+    peer_key = "<64 lowercase hex characters from the server>"
+    async with Runtime.open(provider=tcp.provider()) as runtime:
+        async with await runtime.connect(tcp.noise.locator(peer_key, "127.0.0.1", 9099)) as session:
+            greeter = await session.fetch("greeter")
+            try:
+                print(await session.send(greeter, "greet", ["world"]))
+            except VowBroken as reason:
+                print(f"the greeter refused: {reason}")
+
+
+asyncio.run(main())
+```
+
+- `fetch` and `send` start the inbound loop when first used, so a client that
+  only makes calls does not need `session.serve()`.
+- `await session.closed()` waits for the session to end without closing it or
+  starting that loop. Cancelling the waiter leaves the session running.
+- `Host.publish_durable(behavior, entropy=None)` publishes `behavior` under a
+  durable swiss number, the secret name a peer uses to fetch it later. Pass the
+  same entropy to a Host reconstructed from the same seed to restore that name.
+
+## Sessions and actors
+
+Python values map directly to glowcap values: integers, floats, booleans,
+bytes, strings, and lists, plus `Symbol`, `Keyword`, `Set`, `Tagged`, `Struct`,
+the fulfilled-data `ErrorValue`, and the capability type `Ref`. Returning an
+`ErrorValue` fulfills the caller's `RemotePromise` with that error as data.
+Raising an exception or returning a broken vow rejects it.
+
+`await tcp.listen(host, port)` returns a `tcp.Server` whose iterator yields a
+`Session` for each partner. `publish` and `spawn` host ordinary Python
+callables. `send` returns a `RemotePromise`, implemented as an
+`asyncio.Future`, and that promise can be the target of another send.
+
+Under `Runtime` and `listen`, an `iroh`, `noise-tcp`, `keyed-tcp`, or `tcp`
+connection runs on glowcap's driver loop, one event loop in the C library that
+owns the sockets, frames and moves bytes, and releases finished sessions.
+Python loads the separate Host and driver libraries and steps the loop, while
+asyncio waits on a file descriptor that signals when the loop has work.
+
+Pass `iroh.provider(config)`, `tcp.provider(config)`, or another transport
+package to choose a transport. The driver starts with no transports and
+installs the one you pass. A routed `keyed-relay` or `noise-relay` locator
+likewise loads the relay library and installs its provider.
+
+`Runtime.open(adopt_host=host, ...)` transfers an existing Host into the
+Runtime. `await runtime.close()` then shuts that Host down for good.
+
+`tcp.listen`, `tcp.keyed.listen`, and `tcp.noise.listen` return the same
+`tcp.Server`. Its `locator` and `uri` are ready to hand to `Runtime.connect`.
+
+- Pass a 32-byte `seed` to keep the same identity (the designator in the
+  locator) across restarts.
+- The driver loop accepts incoming connections and limits concurrent
+  handshakes.
+- A wildcard `bind_host` requires `advertised_host`, the name or address
+  partners dial. glowcap puts it in the locator because it cannot infer
+  reachability from the bind.
+
+`relay.keyed.listen` and `relay.noise.listen` return the same `DriverServer`
+shape over a registered relay route. Their `locator` and `uri` carry the
+durable key and the rendezvous relay that partners dial.
+
+A handoff is how one peer gives you a reference to an object hosted by a third
+peer. With one Host shared across sessions, a handoff needs no extra code. The
+less common `send_redeeming` call returns both the answer and `via`, the
+session to the peer that hosts the object. Host a reply capability on `via`. A
+local reference is valid only in the session where it was exported.
+
+## Transports
+
+| Module | Purpose |
+| --- | --- |
+| `glowcap` | Async sessions, hosts, values, locators, and actors. |
+| `glowcap.tcp` | Typed TCP-profile locators, the complete provider package, and blocking frame handles. |
+| `glowcap.inproc` | Blocking in-process connections. |
+| `glowcap.onion` | Configured `listen` through a Tor daemon you run, plus raw Netlayer handles for a program that owns its own loop. |
+| `glowcap.iroh` | Optional encrypted QUIC and `listen`. |
+| `glowcap.webrtc` | Optional WebRTC dial and listen. See below. |
+| `glowcap.relay` | `keyed-relay`/`noise-relay` provider composition and managed listeners. |
+
+WebRTC needs a `SignalingAuthority` that you write to carry each exchange's
+offer, answer, and candidates. `webrtc.provider(signaling)` installs the dial.
+`await webrtc.listen(signaling)` returns a `Server` you iterate for sessions.
+Hand each inbound offer to `server.provide_offer(designator, sdp)`.
+
+The application imports only the transport modules it composes. A TCP-only
+program never loads the iroh or WebRTC library.
+
+A `keyed-relay` locator names a peer that opens no socket of its own. Instead,
+a relay holds inbound connections for it under its key.
+
+- When the locator carries a `rendezvous-relay` hint, `Runtime.connect` routes
+  through the relay provider.
+- For a bare locator, use `relay.connector(config)`. The route comes from the
+  locator's hint or from the connector's configuration, as in every binding.
+  Connections go through the connector only when your code creates one.
+- The connector's client is the one optional dependency: install
+  `glowcap[rendezvous]`. Repository checks install that extra
+  from the committed lock with
+  `uv run --project bindings/python --extra rendezvous --locked`.
+
+The lower-level transports are also available directly:
+
+```python
+from glowcap.tcp import TcpNetlayer
+
+with TcpNetlayer() as netlayer:
+    listener = netlayer.listen("127.0.0.1", 0)
+    connection = netlayer.connect("127.0.0.1", listener.port())
+```
+
+## Tests
+
+```sh
+zig build python-dogfood         # the package against a glowcap peer
+zig build python-goblins-interop # the package against a Spritely Goblins peer
+```
+
+`zig build bindings` builds the libraries and runs the tests for every
+language binding. [`zig_smoke.py`](zig_smoke.py) is a complete example program.
+
+For the shared API, read the [binding overview](../README.md). Maintainers of
+the private FFI loaders and pump should read
+[Developing a binding](../DEVELOPING.md).

glowcap-0.1.1/README.md

@@ -0,0 +1,154 @@
+# Python binding
+
+This package lets Python connect to OCapN peers, call their objects, and host
+objects of its own. It uses `ctypes`, `asyncio`, and the standard library, and
+needs the CPython version `pyproject.toml` declares on an LP64 (64-bit Unix)
+platform. Terms such as locator, vat, and sturdyref are defined in the
+[glossary](../../docs/capabilities.md#glossary).
+
+```sh
+pip install glowcap
+```
+
+On first import the package downloads the C libraries of its version from the
+GitHub release and verifies them against its checksum file. Set
+`GLOWCAP_LIB_DIR` to an extracted C SDK's `lib/` directory to use a local copy.
+In a checkout of the repository, run `zig build` and make the tree's package
+importable instead:
+
+```sh
+export PYTHONPATH="$PWD/bindings/python${PYTHONPATH:+:$PYTHONPATH}"
+```
+
+```python
+import asyncio
+
+from glowcap import Runtime, tcp, VowBroken
+
+
+async def main():
+    peer_key = "<64 lowercase hex characters from the server>"
+    async with Runtime.open(provider=tcp.provider()) as runtime:
+        async with await runtime.connect(tcp.noise.locator(peer_key, "127.0.0.1", 9099)) as session:
+            greeter = await session.fetch("greeter")
+            try:
+                print(await session.send(greeter, "greet", ["world"]))
+            except VowBroken as reason:
+                print(f"the greeter refused: {reason}")
+
+
+asyncio.run(main())
+```
+
+- `fetch` and `send` start the inbound loop when first used, so a client that
+  only makes calls does not need `session.serve()`.
+- `await session.closed()` waits for the session to end without closing it or
+  starting that loop. Cancelling the waiter leaves the session running.
+- `Host.publish_durable(behavior, entropy=None)` publishes `behavior` under a
+  durable swiss number, the secret name a peer uses to fetch it later. Pass the
+  same entropy to a Host reconstructed from the same seed to restore that name.
+
+## Sessions and actors
+
+Python values map directly to glowcap values: integers, floats, booleans,
+bytes, strings, and lists, plus `Symbol`, `Keyword`, `Set`, `Tagged`, `Struct`,
+the fulfilled-data `ErrorValue`, and the capability type `Ref`. Returning an
+`ErrorValue` fulfills the caller's `RemotePromise` with that error as data.
+Raising an exception or returning a broken vow rejects it.
+
+`await tcp.listen(host, port)` returns a `tcp.Server` whose iterator yields a
+`Session` for each partner. `publish` and `spawn` host ordinary Python
+callables. `send` returns a `RemotePromise`, implemented as an
+`asyncio.Future`, and that promise can be the target of another send.
+
+Under `Runtime` and `listen`, an `iroh`, `noise-tcp`, `keyed-tcp`, or `tcp`
+connection runs on glowcap's driver loop, one event loop in the C library that
+owns the sockets, frames and moves bytes, and releases finished sessions.
+Python loads the separate Host and driver libraries and steps the loop, while
+asyncio waits on a file descriptor that signals when the loop has work.
+
+Pass `iroh.provider(config)`, `tcp.provider(config)`, or another transport
+package to choose a transport. The driver starts with no transports and
+installs the one you pass. A routed `keyed-relay` or `noise-relay` locator
+likewise loads the relay library and installs its provider.
+
+`Runtime.open(adopt_host=host, ...)` transfers an existing Host into the
+Runtime. `await runtime.close()` then shuts that Host down for good.
+
+`tcp.listen`, `tcp.keyed.listen`, and `tcp.noise.listen` return the same
+`tcp.Server`. Its `locator` and `uri` are ready to hand to `Runtime.connect`.
+
+- Pass a 32-byte `seed` to keep the same identity (the designator in the
+  locator) across restarts.
+- The driver loop accepts incoming connections and limits concurrent
+  handshakes.
+- A wildcard `bind_host` requires `advertised_host`, the name or address
+  partners dial. glowcap puts it in the locator because it cannot infer
+  reachability from the bind.
+
+`relay.keyed.listen` and `relay.noise.listen` return the same `DriverServer`
+shape over a registered relay route. Their `locator` and `uri` carry the
+durable key and the rendezvous relay that partners dial.
+
+A handoff is how one peer gives you a reference to an object hosted by a third
+peer. With one Host shared across sessions, a handoff needs no extra code. The
+less common `send_redeeming` call returns both the answer and `via`, the
+session to the peer that hosts the object. Host a reply capability on `via`. A
+local reference is valid only in the session where it was exported.
+
+## Transports
+
+| Module | Purpose |
+| --- | --- |
+| `glowcap` | Async sessions, hosts, values, locators, and actors. |
+| `glowcap.tcp` | Typed TCP-profile locators, the complete provider package, and blocking frame handles. |
+| `glowcap.inproc` | Blocking in-process connections. |
+| `glowcap.onion` | Configured `listen` through a Tor daemon you run, plus raw Netlayer handles for a program that owns its own loop. |
+| `glowcap.iroh` | Optional encrypted QUIC and `listen`. |
+| `glowcap.webrtc` | Optional WebRTC dial and listen. See below. |
+| `glowcap.relay` | `keyed-relay`/`noise-relay` provider composition and managed listeners. |
+
+WebRTC needs a `SignalingAuthority` that you write to carry each exchange's
+offer, answer, and candidates. `webrtc.provider(signaling)` installs the dial.
+`await webrtc.listen(signaling)` returns a `Server` you iterate for sessions.
+Hand each inbound offer to `server.provide_offer(designator, sdp)`.
+
+The application imports only the transport modules it composes. A TCP-only
+program never loads the iroh or WebRTC library.
+
+A `keyed-relay` locator names a peer that opens no socket of its own. Instead,
+a relay holds inbound connections for it under its key.
+
+- When the locator carries a `rendezvous-relay` hint, `Runtime.connect` routes
+  through the relay provider.
+- For a bare locator, use `relay.connector(config)`. The route comes from the
+  locator's hint or from the connector's configuration, as in every binding.
+  Connections go through the connector only when your code creates one.
+- The connector's client is the one optional dependency: install
+  `glowcap[rendezvous]`. Repository checks install that extra
+  from the committed lock with
+  `uv run --project bindings/python --extra rendezvous --locked`.
+
+The lower-level transports are also available directly:
+
+```python
+from glowcap.tcp import TcpNetlayer
+
+with TcpNetlayer() as netlayer:
+    listener = netlayer.listen("127.0.0.1", 0)
+    connection = netlayer.connect("127.0.0.1", listener.port())
+```
+
+## Tests
+
+```sh
+zig build python-dogfood         # the package against a glowcap peer
+zig build python-goblins-interop # the package against a Spritely Goblins peer
+```
+
+`zig build bindings` builds the libraries and runs the tests for every
+language binding. [`zig_smoke.py`](zig_smoke.py) is a complete example program.
+
+For the shared API, read the [binding overview](../README.md). Maintainers of
+the private FFI loaders and pump should read
+[Developing a binding](../DEVELOPING.md).