conduit-connector-sdk 0.1.0.dev1__tar.gz

conduit_connector_sdk-0.1.0.dev1/.gitignore

@@ -0,0 +1,30 @@
+# 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 docs/design/) —
+# do NOT ignore src/conduit/_grpc/**, but ignore ad hoc regeneration scratch.
+buf-generate.log

conduit_connector_sdk-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_connector_sdk-0.1.0.dev1/PKG-INFO

@@ -0,0 +1,245 @@
+Metadata-Version: 2.5
+Name: conduit-connector-sdk
+Version: 0.1.0.dev1
+Summary: Python SDK for building Conduit source and destination connectors.
+Project-URL: Homepage, https://github.com/ConduitIO/conduit-connector-sdk-python
+Project-URL: Repository, https://github.com/ConduitIO/conduit-connector-sdk-python
+Project-URL: Issues, https://github.com/ConduitIO/conduit-connector-sdk-python/issues
+Author: Conduit contributors
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: cdc,conduit,connector,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: grpcio-health-checking<2,>=1.75
+Requires-Dist: grpcio<2,>=1.75
+Requires-Dist: packaging<26,>=23
+Requires-Dist: protobuf<8,>=6.31
+Requires-Dist: pydantic<3,>=2.7
+Provides-Extra: avro
+Requires-Dist: fastavro<2,>=1.9; extra == 'avro'
+Provides-Extra: dev
+Requires-Dist: grpc-stubs<2,>=1.24; extra == 'dev'
+Requires-Dist: grpcio-tools<2,>=1.75; extra == 'dev'
+Requires-Dist: httpx<1,>=0.27; extra == 'dev'
+Requires-Dist: hypothesis<7,>=6.120; extra == 'dev'
+Requires-Dist: mypy<2,>=1.15; extra == 'dev'
+Requires-Dist: pytest-asyncio<1,>=0.25; 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-connector-sdk (Python)
+
+Python SDK for building [Conduit](https://github.com/ConduitIO/conduit) source and
+destination connectors. Connectors built with this SDK run as standalone gRPC
+subprocess plugins — no changes to Conduit itself are required to run one.
+
+> **Status: pre-alpha, under active development.** No release has shipped yet.
+> The public API (`Source`, `Destination`, `Config`, `Record`) is not stable
+> until the v0.19 Phase-1 acceptance criteria in
+> [`docs/design/20260707-python-connector-sdk.md`](docs/design/20260707-python-connector-sdk.md)
+> are met. Treat everything here as subject to change without a deprecation
+> notice until then.
+>
+> **What "GA" means for this repo's first tagged release (v0.20 plan, WS2),
+> stated precisely so it isn't over-read:** GA here means exactly two
+> things -- the acceptance suite (`conduit.testing.acceptance`) is green in
+> CI, and a first tag is published via PyPI Trusted Publishing. It does
+> **not** mean production hardening, edge-case parity with the Go SDK, or a
+> 1.0. The value of that tag is narrow and specific: it unblocks the Rust
+> SDK build, which waits on a *tagged release* existing, not on a merge to
+> `main`. Read every claim in this README with that scope in mind.
+
+## What this is
+
+- A gRPC client/server implementation of `conduit-connector-protocol` v2
+  (`SourcePlugin` / `DestinationPlugin` / `SpecifierPlugin`), wrapped in an
+  idiomatic Python API: `async`/`await` connector methods (with sync-method
+  auto-dispatch to a thread pool), `pydantic`-based config with automatic
+  parameter introspection, and a `bytes | dict` OpenCDC record model instead of
+  Go's `Data` interface.
+- The Python analog of [`conduit-connector-sdk`](https://github.com/ConduitIO/conduit-connector-sdk)
+  (Go). Behavioral parity is a goal; API-shape parity is not — see the design
+  doc's "Alternatives considered" section for why.
+
+## Batching (`sdk.batch.size` / `sdk.batch.delay`)
+
+Every connector gets two SDK-injected config parameters for free -- authors
+never declare them on their own `BaseConfig` -- matching the Go SDK's
+`DestinationWithBatch`/`SourceWithBatch` middleware exactly:
+
+- `sdk.batch.size` (int, default `0`): maximum records per batch before an
+  early flush.
+- `sdk.batch.delay` (Go-duration string, default `0s`): maximum time an
+  incomplete batch waits before flushing.
+
+**Activation threshold, matched exactly from the Go SDK:** batching is only
+active when `size > 1` or `delay > 0`. A `size` of `0` *or* `1` with no
+delay is passthrough -- no accumulation, no background task, one wire
+message in for one wire message/record out (Go's `destination.go:182`/
+`source_middleware.go:709` condition, reproduced verbatim, not rounded to a
+more "intuitive" `size >= 1`).
+
+**On the source side**, this SDK's `Source` ABC has no `read_batch`/`ReadN`
+override point yet (deferred past this phase), so batching buffers
+individual `read()` calls -- Go's own *fallback* behavior when a connector
+doesn't implement `ReadN`, not its optimized path. This is a real, current
+capability gap versus Go, documented (not hidden) in
+`conduit/_batch.py`'s module docstring.
+
+**On the destination side**, incoming `Run` batches are flattened and
+re-grouped by size/delay before `write()` is called -- so `write()` may now
+receive a batch spanning several incoming wire messages. A buffered-but-
+below-threshold remainder is always flushed (written and acked) when the
+stream ends or `Stop()` drains the connector -- batching never drops
+records, per invariant 3 (at-least-once is the floor).
+
+## Avro schema support
+
+`conduit.schema.AvroSchema` (optional -- install with
+`conduit-connector-sdk[avro]`) encodes/decodes plain, headerless Avro
+binary -- the exact wire format `conduit-commons`' `schema/avro` package
+produces via `github.com/hamba/avro/v2` (**not** the Confluent Schema
+Registry wire format; there's no magic-byte/schema-ID header on either
+side). This is a cross-language compatibility claim, proven against golden
+bytes an actual Go program produced with `hamba/avro/v2` directly, not a
+Python-only round-trip -- see `tests/test_schema_avro.py` and
+`tests/testdata/avro_golden.json`.
+
+This SDK does **not** ship a schema registry client (no `SchemaService`
+gRPC stubs are generated) -- an author supplies schema text themselves and
+is responsible for keeping it consistent with the
+`opencdc.{key,payload}.schema.{subject,version}` record metadata (see
+`conduit.record.Metadata.set_payload_schema`/`get_payload_schema`).
+
+## What this is not (yet)
+
+See the design doc's Phase 2/3 breakdown for what's still deliberately
+deferred: a `read_batch`/`ReadN` override point for source connectors (see
+"Batching" above for the current fallback-only behavior), a schema registry
+client, the acceptance-test harness's full test corpus beyond the current
+categories, and any performance claim versus the Go SDK (none ships without
+a committed `benchi` result, per the org's CLAUDE.md).
+
+## Delivery semantics
+
+What this SDK guarantees, and — just as important — what it does not:
+
+**Guaranteed:**
+
+- **At-least-once.** A source record is never acknowledged to the
+  connector's own `ack()` hook until Conduit's `Run` stream sends its
+  position back via `ack_positions` (never speculatively when the record is
+  merely produced) -- see `conduit.source._SourceServicer._consume_acks`.
+- **No silent partial-batch acking.** A destination write failure never
+  assumes an unmentioned record succeeded -- `write()` either returns
+  cleanly (full-batch success), raises `BatchWriteError` with an exhaustive,
+  construction-time-validated per-index accounting, or (any other
+  exception) nacks the *entire* batch. There is no code path that infers
+  "everything not explicitly marked as failed" succeeded — see
+  `conduit.errors.BatchWriteError` and `conduit.destination._DestinationServicer._write_batch`.
+- **Batching never drops records.** A buffered-but-below-threshold
+  remainder is always flushed (and, on the destination side, acked) before
+  a controlled shutdown (stream end, `Stop()`, or a SIGTERM-triggered
+  drain) completes.
+- **Graceful shutdown by default.** SIGTERM drains an in-flight read/write
+  loop (including any buffered batch) before `teardown()` runs, bounded by
+  a watchdog so a genuinely wedged connector still exits.
+
+**Not guaranteed / explicit limits:**
+
+- **Positions/state are the connector author's responsibility.** This SDK
+  round-trips whatever `bytes` a `Source.read()`/`open()` implementation
+  returns; it does not itself provide crash-safe position storage.
+- **A hard-cancelled (not drained) `Run` can lose a buffered-but-unflushed
+  batching remainder.** The controlled shutdown paths above (stream end,
+  `Stop()`, SIGTERM-triggered drain) all flush correctly; an externally
+  torn-down RPC (e.g. the framework cancelling the whole call, not a normal
+  drain) is a documented, narrow-window exception -- see
+  `conduit._batch.collect_batches`'s docstring for exactly why and how this
+  mirrors an already-accepted tradeoff elsewhere in this SDK (an in-flight,
+  never-acked write on a hard stop).
+- **No exactly-once.** Like the Go SDK, redelivery on restart is possible;
+  connectors must tolerate at-least-once delivery.
+- **Structured (`dict`) payloads lose precision on integers beyond `2**53`**
+  (via `google.protobuf.Struct`'s double-precision representation) --
+  silently, by design of the wire format, not a bug in this SDK. Pinned by
+  `tests/test_record_codec.py`.
+- **No schema registry integration, no schema evolution/compatibility
+  checking** -- see "Avro schema support" above.
+
+## Requirements
+
+- Python 3.11+
+- [`uv`](https://docs.astral.sh/uv/) for dependency management (recommended;
+  `pip install -e .[dev]` also works)
+
+## Repo layout
+
+```text
+src/conduit/
+  __init__.py       # public API surface
+  config.py         # BaseConfig, Field, to_parameters()
+  record.py          # Record / Change / Operation / Metadata
+  schema.py           # AvroSchema -- optional, `conduit-connector-sdk[avro]`
+  source.py             # Source ABC
+  destination.py         # Destination ABC
+  _batch.py                # sdk.batch.size/delay middleware (source + destination)
+  serve.py                   # handshake + gRPC server bootstrap
+  _handshake.py                # magic cookie, protocol negotiation, stdout line
+  _build.py                      # `conduit-connector-sdk build` implementation
+  _cli.py                          # `conduit-connector-sdk` console-script entry point
+  _grpc/                             # generated protobuf/grpc stubs (buf generate output)
+  testing/                            # acceptance-test harness (acceptance.py, fixtures.py)
+examples/http-poll-source/             # worked example connector
+docs/design/                             # design docs for this repo
+tests/                                     # unit tests
+```
+
+## Building a standalone connector artifact
+
+Conduit launches a standalone connector as a subprocess with a **clean
+environment** — no inherited `PATH` (design doc §1.1.6). A `pip
+install`-then-shebang-script connector (`#!/usr/bin/env python3`, or an
+activated venv) cannot launch this way: there's no `PATH` for `env` to
+search. `conduit-connector-sdk build` closes that gap:
+
+```shell
+conduit-connector-sdk build examples/http-poll-source -o http-poll-source.pyz
+./http-poll-source.pyz   # directly executable — no `python` prefix, no venv activation
+```
+
+This produces one file with an **absolute** interpreter shebang (resolved
+at build time, never looked up via `PATH`), bundling every third-party
+dependency your connector needs — including compiled-extension
+dependencies like `grpcio`/`pydantic`'s `pydantic-core`, which a plain
+[`zipapp`](https://docs.python.org/3/library/zipapp.html) can't load
+in-place: the artifact extracts itself to a per-build cache directory on
+first run (the same fundamental approach `shiv`/`pex` use), then executes
+your connector's real entry point from those extracted files. Later
+launches of the same build reuse the cache.
+
+**Precondition:** run `build` from an environment where your connector's
+own dependencies are already installed (however you installed them — pip,
+uv, poetry) — it vendors from what's already resolved, not a fresh
+`pip install`. See `conduit/_build.py`'s module docstring for the full
+rationale and known limitations.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md). This SDK sits on Conduit's data path —
+read [`docs/design/20260707-python-connector-sdk.md`](docs/design/20260707-python-connector-sdk.md)
+before proposing changes to the wire adapter, ack/nack logic, or handshake.
+
+## License
+
+[Apache License 2.0](LICENSE).