airbyte-cdk 6.45.7__py3-none-any.whl → 6.45.7.post11.dev14564503945__py3-none-any.whl

airbyte_cdk/cli/README.md

@@ -0,0 +1,63 @@
+# Source Declarative Manifest CLI Usage Guide
+
+This guide explains how to install and use the Source Declarative Manifest (SDM) CLI tool for Airbyte connector development.
+
+## Installation
+
+### Standard Installation
+
+```bash
+pipx install airbyte-cdk
+```
+
+If you encounter an error related to a missing `distutils` module, verify that you are running Python version `<=3.11` and try running:
+
+```bash
+python -m pipx install airbyte-cdk
+```
+
+## Using the CLI
+
+The SDM CLI follows standard Airbyte connector command patterns:
+
+```bash
+source-declarative-manifest [command] --config /path/to/config.json
+```
+
+Where [command] can be:
+
+spec - Show connector specification
+check - Verify connection to the source
+discover - List available streams
+read - Read data from streams
+
+:::caution
+When developing locally (outside a Docker container), the CLI operates in "remote manifest mode" and expects your manifest to be included in your configuration file.
+:::
+
+### Steps for Local Testing
+
+1. Convert your manifest from YAML to JSON
+
+Your manifest is defined in YAML, but must be converted to JSON for the config file. You can use an [online tool](https://onlineyamltools.com/convert-yaml-to-json) to do so.
+
+Create a config file that includes both your config parameters AND the manifest. Add your entire manifest as a JSON object under the `__injected_declarative_manifest` key
+
+Example:
+
+```json
+{
+  "api_key": "very_secret_key",
+  "start_time": "04:20",
+  "__injected_declarative_manifest": {
+    // Insert the JSON version of your manifest here
+  }
+}
+```
+
+2. Run the command against your config file
+
+```bash
+source-declarative-manifest check --config /relative/path/to/config.json
+source-declarative-manifest read --config /relative/path/to/config.json --catalog /relative/path/to/catalog.json
+```

{airbyte_cdk-6.45.7.dist-info → airbyte_cdk-6.45.7.post11.dev14564503945.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: airbyte-cdk
-Version: 6.45.7
+Version: 6.45.7.post11.dev14564503945
 Summary: A framework for writing Airbyte Connectors.
 Home-page: https://airbyte.com
 License: MIT

{airbyte_cdk-6.45.7.dist-info → airbyte_cdk-6.45.7.post11.dev14564503945.dist-info}/RECORD

@@ -1,4 +1,5 @@
 airbyte_cdk/__init__.py,sha256=52uncJvDQNHvwKxaqzXgnMYTptIl65LDJr2fvlk8-DU,11707
+airbyte_cdk/cli/README.md,sha256=yEZyrSfnExsogR6eXgjx7bnRaDUlNzLflMDz8tD4Avo,1796
 airbyte_cdk/cli/__init__.py,sha256=Hu-1XT2KDoYjDF7-_ziDwv5bY3PueGjANOCbzeOegDg,57
 airbyte_cdk/cli/source_declarative_manifest/__init__.py,sha256=-0ST722Nj65bgRokzpzPkD1NBBW5CytEHFUe38cB86Q,91
 airbyte_cdk/cli/source_declarative_manifest/_run.py,sha256=9qtbjt-I_stGWzWX6yVUKO_eE-Ga7g-uTuibML9qLBs,8330
@@ -375,9 +376,9 @@ airbyte_cdk/utils/slice_hasher.py,sha256=EDxgROHDbfG-QKQb59m7h_7crN1tRiawdf5uU7G
 airbyte_cdk/utils/spec_schema_transformations.py,sha256=-5HTuNsnDBAhj-oLeQXwpTGA0HdcjFOf2zTEMUTTg_Y,816
 airbyte_cdk/utils/stream_status_utils.py,sha256=ZmBoiy5HVbUEHAMrUONxZvxnvfV9CesmQJLDTAIWnWw,1171
 airbyte_cdk/utils/traced_exception.py,sha256=C8uIBuCL_E4WnBAOPSxBicD06JAldoN9fGsQDp463OY,6292
-airbyte_cdk-6.45.7.dist-info/LICENSE.txt,sha256=Wfe61S4BaGPj404v8lrAbvhjYR68SHlkzeYrg3_bbuM,1051
-airbyte_cdk-6.45.7.dist-info/LICENSE_SHORT,sha256=aqF6D1NcESmpn-cqsxBtszTEnHKnlsp8L4x9wAh3Nxg,55
-airbyte_cdk-6.45.7.dist-info/METADATA,sha256=UXCqZZpSX2ytKm2Zd7mWa8A_AGen9EvpD_6CcNYwmVk,6113
-airbyte_cdk-6.45.7.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-airbyte_cdk-6.45.7.dist-info/entry_points.txt,sha256=fj-e3PAQvsxsQzyyq8UkG1k8spunWnD4BAH2AwlR6NM,95
-airbyte_cdk-6.45.7.dist-info/RECORD,,
+airbyte_cdk-6.45.7.post11.dev14564503945.dist-info/LICENSE.txt,sha256=Wfe61S4BaGPj404v8lrAbvhjYR68SHlkzeYrg3_bbuM,1051
+airbyte_cdk-6.45.7.post11.dev14564503945.dist-info/LICENSE_SHORT,sha256=aqF6D1NcESmpn-cqsxBtszTEnHKnlsp8L4x9wAh3Nxg,55
+airbyte_cdk-6.45.7.post11.dev14564503945.dist-info/METADATA,sha256=_ac1yVOXqMp_y2mau-0jhPW93Ue4Zer35V_b6TIaqOE,6135
+airbyte_cdk-6.45.7.post11.dev14564503945.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+airbyte_cdk-6.45.7.post11.dev14564503945.dist-info/entry_points.txt,sha256=fj-e3PAQvsxsQzyyq8UkG1k8spunWnD4BAH2AwlR6NM,95
+airbyte_cdk-6.45.7.post11.dev14564503945.dist-info/RECORD,,