airbyte-cdk 6.45.7__tar.gz → 6.45.7.post11.dev14564503945__tar.gz

{airbyte_cdk-6.45.7 → airbyte_cdk-6.45.7.post11.dev14564503945}/PKG-INFO

@@ -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.post11.dev14564503945/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 → airbyte_cdk-6.45.7.post11.dev14564503945}/pyproject.toml

@@ -23,7 +23,7 @@ classifiers = [
 keywords = ["airbyte", "connector-development-kit", "cdk"]
 
 # Python CDK uses dynamic versioning: https://github.com/mtkennerly/poetry-dynamic-versioning
-version = "6.45.7"  # Version will be calculated dynamically.
+version = "6.45.7.post11.dev14564503945"  # Version will be calculated dynamically.
 
 [tool.poetry-dynamic-versioning]
 enable = false