conduit-client 0.1.0.dev1__tar.gz

conduit_client-0.1.0.dev1/.gitignore

@@ -0,0 +1,36 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+
+# Tooling caches
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.hypothesis/
+htmlcov/
+.coverage
+.coverage.*
+
+# uv
+.uv/
+
+# Editors / OS
+.vscode/
+.idea/
+.DS_Store
+
+# Generated protobuf/grpc stubs are checked in (vendored, see
+# tools/generate-stubs.sh and src/conduit/_grpc/__init__.py) -- do NOT ignore
+# src/conduit/_grpc/**, but ignore ad hoc regeneration scratch.
+buf-generate.log
+
+# conduit.local()'s default state_dir (./.conduit/state) and this repo's
+# quickstart example's state dir -- runtime artifacts, never committed.
+.conduit/
+conduit-state/

conduit_client-0.1.0.dev1/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 2022 Meroxa, Inc.
+
+   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.

conduit_client-0.1.0.dev1/PKG-INFO

@@ -0,0 +1,238 @@
+Metadata-Version: 2.5
+Name: conduit-client
+Version: 0.1.0.dev1
+Summary: Python client library for defining and running Conduit pipelines over its control-plane gRPC API.
+Project-URL: Homepage, https://github.com/ConduitIO/conduit-client-python
+Project-URL: Repository, https://github.com/ConduitIO/conduit-client-python
+Project-URL: Issues, https://github.com/ConduitIO/conduit-client-python/issues
+Author: Conduit contributors
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: cdc,client,conduit,embed,etl,grpc,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+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.11
+Requires-Dist: googleapis-common-protos<2,>=1.65
+Requires-Dist: grpcio-status<2,>=1.75
+Requires-Dist: grpcio<2,>=1.75
+Requires-Dist: platformdirs<5,>=4
+Requires-Dist: protobuf<8,>=6.31
+Provides-Extra: dev
+Requires-Dist: grpc-stubs<2,>=1.24; extra == 'dev'
+Requires-Dist: grpcio-tools<2,>=1.75; extra == 'dev'
+Requires-Dist: mypy<2,>=1.15; extra == 'dev'
+Requires-Dist: pytest-timeout<3,>=2.3; extra == 'dev'
+Requires-Dist: pytest<9,>=8.3; extra == 'dev'
+Requires-Dist: ruff<1,>=0.14; extra == 'dev'
+Requires-Dist: types-protobuf<7,>=6.30; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# conduit-client (Python)
+
+Python client library for defining and running [Conduit](https://github.com/ConduitIO/conduit)
+pipelines in code, over Conduit's existing control-plane gRPC API
+(`proto/api/v1/api.proto`). No changes to Conduit itself are required.
+
+> **Status: pre-alpha, Slice 1.** Implements
+> [`docs/design/20260724-embed-grpc-client-libraries.md`](docs/design/20260724-embed-grpc-client-libraries.md)'s
+> "Build slices -- Slice 1": Case A (named connector plugins) only. No release has
+> shipped; the public API (`Pipeline`, `local`, `connect`, `Client`, `Run`) is
+> not stable until it ships. See "Open questions for DeVaris" below.
+
+## What this is
+
+- A **builder** for pipeline configs (`Pipeline(id).source(...).destination(...).process(...)`)
+  that produces the exact request payloads Conduit's `PipelineService`/
+  `ConnectorService`/`ProcessorService` RPCs expect -- no YAML, no shelling out
+  to the `conduit` CLI.
+- A **sync gRPC client** (`conduit.connect(addr)`) for an already-running,
+  independently deployed Conduit engine -- the production shape.
+- A **local-engine supervisor** (`conduit.local(...)`) that downloads a
+  pinned `conduit` release binary on first use, spawns it with its API
+  enabled on loopback, and hands you a client bound to it -- for dev,
+  notebooks, and one-off jobs. **Not a production story** -- see "Deployment
+  modes" below.
+- Errors are always `conduit.ConduitError` (a stable code, message, and
+  optional config path/suggestion) -- never a raw `grpc.RpcError` or
+  traceback.
+
+Why gRPC and not a C-ABI/FFI shared library: see
+[`docs/design/20260724-embed-bindings-via-grpc.md`](docs/design/20260724-embed-bindings-via-grpc.md)
+(the ADR) -- in short, the hot record-processing path never crosses the
+embedding boundary, only low-frequency lifecycle/status calls do, so gRPC's
+cost (a loopback network hop on those calls) is real but small, and it comes
+with a working story for driving an already-deployed remote engine that a
+C-ABI structurally cannot have.
+
+## Quickstart
+
+```python
+import conduit
+
+pipeline = (
+    conduit.Pipeline("orders-sync")
+    .source("generator", settings={"format.type": "structured"}, operations="create")
+    .destination("log", level="info")
+)
+
+with conduit.local(state_dir="./conduit-state") as client:
+    run = client.run(pipeline)
+    run.wait_running()
+    print(run.status())
+    run.stop()
+```
+
+First run downloads a pinned `conduit` release binary (see "Binary
+provisioning" below); later runs reuse the cached copy. `state_dir` is
+required to be a real, reused directory for anything beyond a one-off
+experiment -- see "Deployment modes."
+
+## Requirements
+
+- Python 3.11+
+- [`uv`](https://docs.astral.sh/uv/) for dependency management (recommended;
+  `pip install -e .[dev]` also works)
+- Network access on first `conduit.local()` call per version (binary
+  download), unless you pass `binary=` to point at an already-present
+  executable.
+
+## Repo layout
+
+```text
+src/conduit/
+  __init__.py    # public API surface
+  pipeline.py    # Pipeline builder -> BuildPlan (pure, no I/O)
+  client.py      # Client (gRPC stubs), connect()
+  run.py         # Run handle, RunStatus
+  errors.py      # ConduitError, grpc.RpcError -> ConduitError translation
+  _local.py      # local(): binary provisioning + subprocess supervision
+  _provision.py  # download-on-first-use, checksum-verified binary provisioning
+  _grpc/         # generated protobuf/grpc stubs (buf generate output)
+docs/design/     # design doc + ADR this repo implements (copied from ConduitIO/conduit)
+tests/unit/      # builder/error/provisioning unit tests (no network, no subprocess)
+tests/integration/  # spins up a real conduit via local() -- see "Testing" below
+```
+
+## The client API surface
+
+- **`conduit.Pipeline(id, *, name=None, description="")`** -- fluent builder.
+  `.source(plugin, *, name="", settings=None, **kwargs)`, `.destination(...)`
+  (same shape), `.process(plugin, *, condition="", workers=None, settings=None,
+  **kwargs)` (pipeline-level; per-connector processor attachment is a natural
+  follow-up, not yet exposed), `.dlq(plugin="builtin:log", *, window_size=None,
+  window_nack_threshold=None, settings=None, **kwargs)`.
+  Config values are coerced to strings -- `Connector.Config.settings`/
+  `Processor.Config.settings` are a flat `map<string, string>` on the wire
+  today. **Real connector config keys are often not valid Python identifiers**
+  (e.g. the builtin generator connector's `format.type`, `sdk.batch.size`) --
+  use the explicit `settings={"format.type": "structured"}` dict for those;
+  plain identifier-shaped keys can use `**kwargs` (`operations="create"`)
+  instead, and both can be combined in the same call. **Typed per-connector
+  config** (`postgres.Source(url=..., tables=[...])` with real parameter
+  types, generated from each plugin's param spec) is the documented
+  fast-follow, not hand-written per connector.
+- **`conduit.local(state_dir=None, *, version=None, binary=None, startup_timeout=30.0)`**
+  -- provisions (if needed), spawns, and waits for a `conduit` subprocess;
+  returns a client-like `LocalConduit` (context manager, or call `.close()`
+  yourself).
+- **`conduit.connect(addr, *, credentials=None, check_version=True, timeout=5.0)`**
+  -- dials an already-running engine; returns a `Client`.
+- **`client.run(pipeline, *, start=True, timeout=10.0) -> Run`** -- creates the
+  pipeline, its connectors and processors, applies the DLQ if configured, and
+  starts it (unless `start=False`).
+- **`run.wait_running(timeout=30.0, poll_interval=0.2)`**, **`run.status()`**
+  (-> `RunStatus`: `status`, `error`, `stopped_reason`, `is_running`,
+  `is_degraded`), **`run.stop(force=False, timeout=10.0)`**.
+
+## RPCs this client drives
+
+Exactly the incremental CRUD-plus-lifecycle RPCs in `proto/api/v1/api.proto`
+(not `PlanPipeline`/`ApplyPipeline`'s whole-document shape, which is a
+different, YAML-provisioner-aligned surface):
+
+- `PipelineService`: `CreatePipeline`, `GetPipeline`, `StartPipeline`,
+  `StopPipeline`, `UpdateDLQ`.
+- `ConnectorService`: `CreateConnector`.
+- `ProcessorService`: `CreateProcessor`.
+- `InformationService`: `GetInfo` (engine version check at connect-time).
+
+`UpdatePipeline`/`DeletePipeline`/`UpdateConnector`/`DeleteConnector`/
+`UpdateProcessor`/`DeleteProcessor`/`ListPipelines`/etc. are defined on the
+generated stubs (nothing stops a caller reaching for `Client._pipelines`
+directly) but have no builder-level convenience yet -- Slice 1 scope is
+"define + run," not full lifecycle management.
+
+## Deployment modes -- framed honestly
+
+- **Mode 1, `conduit.local()`**: engine co-located with your process, tied to
+  its lifecycle. Fits dev, notebooks, one-off jobs. **Never sell this as a
+  production pipeline story** -- no independent lifecycle, no
+  restart-without-the-host-restarting, no fleet management. `state_dir`
+  defaults to `./.conduit/state` (stable across repeated runs in the same
+  directory) rather than an ephemeral temp dir, but a host-process crash still
+  takes the engine down with it.
+- **Mode 2, `conduit.connect(addr)`**: a deployed, long-running Conduit
+  service, managed independently (systemd, Kubernetes, ...). This is what a
+  production pipeline should use.
+
+`inline_source`/`inline_destination` (Case B, driving a host-implemented
+Python connector via a new engine-side "external connector" feature) is
+**Slice 2**, not built here -- it needs its own engine-side design-doc sign-off
+pass per the design doc (Tier 1, touches connector acquisition).
+
+## Binary provisioning
+
+`conduit.local()` never looks at `PATH`. It downloads a specific,
+version-pinned GoReleaser release asset
+(`conduit_<version>_<Os>_<Arch>.tar.gz`, `.zip` on Windows) from
+[GitHub Releases](https://github.com/ConduitIO/conduit/releases), verifies its
+SHA-256 against the release's published `checksums.txt`, extracts the
+`conduit` binary, and caches it under a per-version directory in your user
+cache dir (`platformdirs.user_cache_dir("conduit-client-python")`). A second
+call with the same version reuses the cache with no network access. Pass
+`binary=` to point at an already-present executable instead (skips
+provisioning entirely) -- useful for CI images that pre-bake a specific build.
+
+The default version is pinned in `conduit._provision.DEFAULT_CONDUIT_VERSION`
+(currently the latest stable release at the time this was written); override
+with `local(version="0.19.0")` or the `CONDUIT_CLIENT_ENGINE_VERSION` env var.
+
+## Testing
+
+```bash
+uv sync --all-extras
+uv run pytest -v -m "not integration"   # unit tests: no network, no subprocess
+uv run pytest -v -m integration         # spins up a real conduit binary end-to-end
+```
+
+The integration test (`tests/integration/test_local_generator_log.py`) runs
+`conduit.local()` for real and drives a `generator -> log` pipeline through
+`run()`/`wait_running()`/`stop()`. It downloads a real release binary on
+first use -- **if the sandbox running these tests has no network access, it
+is honestly marked `skip` with the reason stated** (see the test file), never
+faked or mocked into looking like a pass.
+
+## Open questions for DeVaris
+
+See the design doc's "Open questions for DeVaris" for the full list; the ones
+this repo's existence doesn't yet resolve:
+
+1. **PyPI distribution name.** ~~This repo uses the working name
+   `conduit-client` in `pyproject.toml` -- not settled against
+   `conduit-embed`/bare `conduit`.~~ Settled 2026-08-29 by DeVaris:
+   `conduit-client`. Claimed permanently by the first publish.
+2. **Release target** (v0.19 fast-follow vs. v0.20 anchor).
+3. Binary provisioning here is **download-on-first-use with checksum
+   verification** (not a bundled-per-platform wheel) -- lighter package,
+   needs network + GitHub Releases availability. Confirms the design doc's
+   open question 3 in the "lighter, needs network" direction; flag if that's
+   wrong for the intended distribution story.
+
+## License
+
+[Apache License 2.0](LICENSE).