airbyte-cdk 6.56.7.post1.dev15934698385__py3-none-any.whl → 6.56.8__py3-none-any.whl

airbyte_cdk/__init__.py

@@ -32,6 +32,16 @@ The Airbyte CDK provides a set of classes that help you work with the Airbyte pr
 - `airbyte_cdk.models.airbyte_protocol`
 - `airbyte_cdk.models.airbyte_protocol_serializers`
 
+## Using the CLI (`airbyte_cdk.cli`)
+
+The Airbyte CDK provides two command-line interfaces (CLIs) for interacting with the framework.
+
+- `airbyte-cdk`: This is the main CLI for the Airbyte CDK. It provides commands for building
+  and testing connectors, as well as other utilities. See the `airbyte_cdk.cli.airbyte_cdk` module
+  for more details.
+- `source-declarative-manifest`: This command allows you to run declarative manifests directly.
+  See the `airbyte_cdk.cli.source_declarative_manifest` module for more details.
+
 ---
 
 API Reference
@@ -129,7 +139,6 @@ from .sources.declarative.schema import JsonFileSchemaLoader
 from .sources.declarative.transformations.add_fields import AddedFieldDefinition, AddFields
 from .sources.declarative.transformations.transformation import RecordTransformation
 from .sources.declarative.types import FieldPointer
-from .sources.declarative.validators import DpathValidator, PredicateValidator, ValidateAdheresToSchema, ValidationStrategy, Validator
 from .sources.declarative.yaml_declarative_source import YamlDeclarativeSource
 from .sources.message import InMemoryMessageRepository, MessageRepository
 from .sources.source import TState
@@ -340,12 +349,6 @@ __all__ = [
     "Record",
     "Source",
     "StreamSlice",
-    # Validators
-    "Validator",
-    "DpathValidator",
-    "PredicateValidator",
-    "ValidationStrategy",
-    "ValidateAdheresToSchema",
 ]
 
 __version__: str

airbyte_cdk/cli/source_declarative_manifest/README.md

@@ -0,0 +1,65 @@
+# Source Declarative Manifest CLI
+
+The source-declarative-manifest CLI is included in the airbyte-cdk package.
+This CLI enables connector interfaces to be run locally on manifest-only connectors,
+much like we already do with Python connectors.
+
+## Installation
+
+The airbyte-cdk library can be installed globally using pipx:
+
+```bash
+pipx install airbyte-cdk
+```
+
+If you are using a cloned airbyte-python-cdk repo locally,
+you can also create a virtual environment to enable the CLI.
+From the root directory of airbyte-python-cdk:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -e .
+```
+
+## Usage
+
+### Options
+
+--help: displays the list of available commands
+
+### Commands
+
+- spec: Outputs the JSON configuration specification. NOTE: This currently just outputs the base source-declarative-manifest spec
+- check: Runs a connection_check to verify a connection can be made with the passed config
+- discover: Outputs a catalog describing the source's schema
+- read: Reads the source using the passed config and catalog, and outputs messages to STDOUT
+
+### Command options
+
+- --config: The relative path to the config to inject into SDM.
+- --catalog: The relative path to the configured catalog.
+- --state: The relative path to the state object to pass. Only used when running an incremental read.
+- --manifest-path: The relative path to the local YAML manifest to inject into SDM.
+- --components-path: The relative path to the custom components to mount, if they exist.
+
+| Option              | spec | check    | discover | read     |
+| ------------------- | ---- | -------- | -------- | -------- |
+| `--config`          | ❌   | required | required | required |
+| `--catalog`         | ❌   | ❌       | required | required |
+| `--state`           | ❌   | ❌       | ❌       | optional |
+| `--manifest-path`   | ❌   | required | required | required |
+| `--components-path` | ❌   | optional | optional | optional |
+
+### Examples
+
+Here are some basic examples of how to run source-declarative-manifest commands locally.
+Note that the paths are relative. These examples assume the user is currently at the root level of a connector dir:
+
+```bash
+source-declarative-manifest check --config secrets/config.json --manifest-path manifest.yaml
+```
+
+```bash
+source-declarative-manifest read --config secrets/config.json --catalog integration_tests/configured_catalog.json --manifest-path manifest.yaml --components-path components.py
+```

airbyte_cdk/cli/source_declarative_manifest/__init__.py

@@ -1,3 +1,8 @@
+"""
+.. include:: ./README.md
+   :start-line: 2
+"""
+
 from airbyte_cdk.cli.source_declarative_manifest._run import run
 
 __all__ = [

airbyte_cdk/cli/source_declarative_manifest/_run.py

@@ -299,5 +299,9 @@ def _register_components_from_file(filepath: str) -> None:
 
 
 def run() -> None:
+    """Run the `source-declarative-manifest` CLI.
+
+    Args are detected from the command line, and the appropriate command is executed.
+    """
     args: list[str] = sys.argv[1:]
     handle_command(args)

airbyte_cdk/manifest_migrations/migrations/http_requester_request_body_json_data_to_request_body.py

@@ -54,7 +54,7 @@ class HttpRequesterRequestBodyJsonDataToRequestBody(ManifestMigration):
         if isinstance(manifest[key], str):
             self._migrate_value(manifest, key, text_type)
         elif isinstance(manifest[key], dict):
-            if manifest[key].get(query_key) is not None:
+            if isinstance(manifest[key].get(query_key), str):
                 self._migrate_value(manifest, key, graph_ql_type)
             else:
                 self._migrate_value(manifest, key, json_object_type)

airbyte_cdk/sources/declarative/declarative_component_schema.yaml

@@ -2140,30 +2140,6 @@ definitions:
           - stream_interval
           - stream_partition
           - stream_slice
-        examples:
-          - type: RequestBodyJsonObject
-            value:
-              sort_order: "ASC"
-              sort_field: "CREATED_AT"
-          - type: RequestBodyJsonObject
-            value:
-              key: "{{ config['value'] }}"
-          - type: RequestBodyJsonObject
-            value:
-              sort:
-                field: "updated_at"
-                order: "ascending"
-          - type: RequestBodyPlainText
-            value: "plain_text_body"
-          - type: RequestBodyUrlEncodedForm
-            value:
-              param1: "value1"
-              param2: "{{ config['param2_value'] }}"
-          - type: RequestBodyGraphQL
-            value:
-              query:
-                param1: "value1"
-                param2: "{{ config['param2_value'] }}"
       error_handler:
         title: Error Handler
         description: Error handler component that defines how to handle errors.
@@ -4326,10 +4302,9 @@ definitions:
       - query
     properties:
       query:
-        type: object
-        additionalProperties: true
+        type: string
         description: The GraphQL query to be executed
-        default: {}
+        default: "query {\n    \n}"
     additionalProperties: true
   DpathValidator:
     title: Dpath Validator

airbyte_cdk/sources/declarative/models/declarative_component_schema.py

@@ -1554,7 +1554,7 @@ class RequestBodyGraphQlQuery(BaseModel):
     class Config:
         extra = Extra.allow
 
-    query: Dict[str, Any] = Field(..., description="The GraphQL query to be executed")
+    query: str = Field(..., description="The GraphQL query to be executed")
 
 
 class ValidateAdheresToSchema(BaseModel):
@@ -2595,34 +2595,6 @@ class HttpRequester(BaseModelWithDeprecations):
     ] = Field(
         None,
         description="Specifies how to populate the body of the request with a payload. Can contain nested objects.",
-        examples=[
-            {
-                "type": "RequestBodyJsonObject",
-                "value": {"sort_order": "ASC", "sort_field": "CREATED_AT"},
-            },
-            {
-                "type": "RequestBodyJsonObject",
-                "value": {"key": "{{ config['value'] }}"},
-            },
-            {
-                "type": "RequestBodyJsonObject",
-                "value": {"sort": {"field": "updated_at", "order": "ascending"}},
-            },
-            {"type": "RequestBodyPlainText", "value": "plain_text_body"},
-            {
-                "type": "RequestBodyUrlEncodedForm",
-                "value": {"param1": "value1", "param2": "{{ config['param2_value'] }}"},
-            },
-            {
-                "type": "RequestBodyGraphQL",
-                "value": {
-                    "query": {
-                        "param1": "value1",
-                        "param2": "{{ config['param2_value'] }}",
-                    }
-                },
-            },
-        ],
         title="Request Body",
     )
     error_handler: Optional[

airbyte_cdk/sources/declarative/requesters/request_options/interpolated_request_options_provider.py

@@ -100,7 +100,7 @@ class InterpolatedRequestOptionsProvider(RequestOptionsProvider):
             if self.request_body.type == "RequestBodyUrlEncodedForm":
                 self.request_body_data = self.request_body.value
             elif self.request_body.type == "RequestBodyGraphQL":
-                self.request_body_json = {"query": self.request_body.value.query}
+                self.request_body_json = self.request_body.value.dict(exclude_none=True)
             elif self.request_body.type in ("RequestBodyJsonObject", "RequestBodyPlainText"):
                 self.request_body_json = self.request_body.value
             else:

airbyte_cdk/sources/declarative/validators/dpath_validator.py

@@ -53,7 +53,7 @@ class DpathValidator(Validator):
                 for value in values:
                     self.strategy.validate(value)
             except KeyError as e:
-                logger.warning(f"Error validating path. Key not found: {e}")
+                logger.info(f"Validation skipped. Key not found: {e}")
                 return
 
         else:
@@ -61,5 +61,5 @@ class DpathValidator(Validator):
                 value = dpath.get(input_data, path)
                 self.strategy.validate(value)
             except KeyError as e:
-                logger.warning(f"Error validating path. Key not found: {e}")
+                logger.info(f"Validation skipped. Key not found: {e}")
                 return

{airbyte_cdk-6.56.7.post1.dev15934698385.dist-info → airbyte_cdk-6.56.8.dist-info}/METADATA

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

{airbyte_cdk-6.56.7.post1.dev15934698385.dist-info → airbyte_cdk-6.56.8.dist-info}/RECORD

@@ -1,4 +1,4 @@
-airbyte_cdk/__init__.py,sha256=r2Kow-7clQUNUdsgY4Mo3z9CIOH52vJ6Nz8UJ2K8g9M,11981
+airbyte_cdk/__init__.py,sha256=lZNgioD1bHnzRbPK-TXjo7JOVKEL8mz9b5uflj-wIFI,12232
 airbyte_cdk/cli/__init__.py,sha256=CXsai3MYMLZ_sqi2vPAIVcKDun8VRqlv0cKffBI0iSY,346
 airbyte_cdk/cli/airbyte_cdk/__init__.py,sha256=8IoEcbdYr7CMAh97Xut5__uHH9vV4LKUtSBNTk3qEWY,2031
 airbyte_cdk/cli/airbyte_cdk/_connector.py,sha256=u5T_puPDVIsI-jdaQRsPI-Hd4AGoaVY8no2zgMFVOXQ,6164
@@ -7,8 +7,9 @@ airbyte_cdk/cli/airbyte_cdk/_manifest.py,sha256=aFdeeWgek7oXR3YfZPxk7kBZ64Blmsr0
 airbyte_cdk/cli/airbyte_cdk/_secrets.py,sha256=zkO9bO5pfOA-EJb0HRdEdSiybMFkyiqiQ6MWXldAg0s,17630
 airbyte_cdk/cli/airbyte_cdk/_version.py,sha256=ohZNIktLFk91sdzqFW5idaNrZAPX2dIRnz---_fcKOE,352
 airbyte_cdk/cli/airbyte_cdk/exceptions.py,sha256=bsGmlWN6cXL2jCD1WYAZMqFmK1OLg2xLrcC_60KHSeA,803
-airbyte_cdk/cli/source_declarative_manifest/__init__.py,sha256=-0ST722Nj65bgRokzpzPkD1NBBW5CytEHFUe38cB86Q,91
-airbyte_cdk/cli/source_declarative_manifest/_run.py,sha256=jo4yydSDrB157GtTSZPWRfhZHYvFUD_btI5LW7wOrmY,11129
+airbyte_cdk/cli/source_declarative_manifest/README.md,sha256=aviNYFk1qKXGm33NQ2mJtJNyQ1MO0SPrm_fggUs0MVE,2460
+airbyte_cdk/cli/source_declarative_manifest/__init__.py,sha256=F-DFREvW6Sz71nSu0MwVALaybs9veg678tvsGFi2dYo,143
+airbyte_cdk/cli/source_declarative_manifest/_run.py,sha256=gaWQTMKGF9pe1VjNz2WCk_SclJX3gL31Eui0-jGxEqA,11274
 airbyte_cdk/cli/source_declarative_manifest/spec.json,sha256=Earc1L6ngcdIr514oFQlUoOxdF4RHqtUyStSIAquXdY,554
 airbyte_cdk/config_observation.py,sha256=7SSPxtN0nXPkm4euGNcTTr1iLbwUL01jy-24V1Hzde0,3986
 airbyte_cdk/connector.py,sha256=N6TUlrZOMjLAI85JrNAKkfyTqnO5xfBCw4oEfgjJd9o,4254
@@ -43,7 +44,7 @@ airbyte_cdk/manifest_migrations/manifest_migration.py,sha256=4ohLfbj2PeuPSgCMVbC
 airbyte_cdk/manifest_migrations/migration_handler.py,sha256=xVTvGoSsTpSLd2mOXHL_D0MxQMGuumiAqW-YWJYfQdY,6716
 airbyte_cdk/manifest_migrations/migrations/__init__.py,sha256=HRN7fMMbTuM9W1vmycmw9GrXAHH2DYOaYKl3k3p98tw,592
 airbyte_cdk/manifest_migrations/migrations/http_requester_path_to_url.py,sha256=IIn2SjRh1v2yaSBFUCDyBHpX6mBhlckhvbsSg55mREI,2153
-airbyte_cdk/manifest_migrations/migrations/http_requester_request_body_json_data_to_request_body.py,sha256=4nX0oUcFytjpCFnz-oEf4JpeROP7_NBOEX9gCKFoBgg,2726
+airbyte_cdk/manifest_migrations/migrations/http_requester_request_body_json_data_to_request_body.py,sha256=hwz2JZYSUibpoD983DMrOdcFYApiHkTVayBkeG2Kx9w,2731
 airbyte_cdk/manifest_migrations/migrations/http_requester_url_base_to_url.py,sha256=EX1MVYVpoWypA28qoH48wA0SYZjGdlR8bcSixTDzfgo,1346
 airbyte_cdk/manifest_migrations/migrations/registry.yaml,sha256=SITcsFFf0avFYZzEb4X2K4W_lXAHrXry9qoEhEVFQvg,957
 airbyte_cdk/manifest_migrations/migrations_registry.py,sha256=zly2fwaOxDukqC7eowzrDlvhA2v71FjW74kDzvRXhSY,2619
@@ -89,7 +90,7 @@ airbyte_cdk/sources/declarative/concurrent_declarative_source.py,sha256=rQz9gXp3
 airbyte_cdk/sources/declarative/datetime/__init__.py,sha256=4Hw-PX1-VgESLF16cDdvuYCzGJtHntThLF4qIiULWeo,61
 airbyte_cdk/sources/declarative/datetime/datetime_parser.py,sha256=_zGNGq31RNy_0QBLt_EcTvgPyhj7urPdx6oA3M5-r3o,3150
 airbyte_cdk/sources/declarative/datetime/min_max_datetime.py,sha256=0BHBtDNQZfvwM45-tY5pNlTcKAFSGGNxemoi0Jic-0E,5785
-airbyte_cdk/sources/declarative/declarative_component_schema.yaml,sha256=J7y_7HJdJMBhngGH3eprGQTlHv_eYGBpD8xe2su5KAs,181284
+airbyte_cdk/sources/declarative/declarative_component_schema.yaml,sha256=kl0_g1yx8sdtDQ8dUQXXW3uHBLyjgM2DMFhimfmUNS4,180477
 airbyte_cdk/sources/declarative/declarative_source.py,sha256=qmyMnnet92eGc3C22yBtpvD5UZjqdhsAafP_zxI5wp8,1814
 airbyte_cdk/sources/declarative/declarative_stream.py,sha256=dCRlddBUSaJmBNBz1pSO1r2rTw8AP5d2_vlmIeGs2gg,10767
 airbyte_cdk/sources/declarative/decoders/__init__.py,sha256=JHb_0d3SE6kNY10mxA5YBEKPeSbsWYjByq1gUQxepoE,953
@@ -133,7 +134,7 @@ airbyte_cdk/sources/declarative/migrations/legacy_to_per_partition_state_migrati
 airbyte_cdk/sources/declarative/migrations/state_migration.py,sha256=KWPjealMLKSMtajXgkdGgKg7EmTLR-CqqD7UIh0-eDU,794
 airbyte_cdk/sources/declarative/models/__init__.py,sha256=nUFxNCiKeYRVXuZEKA7GD-lTHxsiKcQ8FitZjKhPIvE,100
 airbyte_cdk/sources/declarative/models/base_model_with_deprecations.py,sha256=Imnj3yef0aqRdLfaUxkIYISUb8YkiPrRH_wBd-x8HjM,5999
-airbyte_cdk/sources/declarative/models/declarative_component_schema.py,sha256=_vSttuYgevivyK3SJZjMvs7p4NP7pqS9F1c1ei3DJ7M,128009
+airbyte_cdk/sources/declarative/models/declarative_component_schema.py,sha256=zNCb_E42naPkhWmUuquHRx8_7xXO6IbS3VZm-9pkqCc,126988
 airbyte_cdk/sources/declarative/parsers/__init__.py,sha256=ZnqYNxHsKCgO38IwB34RQyRMXTs4GTvlRi3ImKnIioo,61
 airbyte_cdk/sources/declarative/parsers/custom_code_compiler.py,sha256=nlVvHC511NUyDEEIRBkoeDTAvLqKNp-hRy8D19z8tdk,5941
 airbyte_cdk/sources/declarative/parsers/custom_exceptions.py,sha256=wnRUP0Xeru9Rbu5OexXSDN9QWDo8YU4tT9M2LDVOgGA,802
@@ -189,7 +190,7 @@ airbyte_cdk/sources/declarative/requesters/request_options/datetime_based_reques
 airbyte_cdk/sources/declarative/requesters/request_options/default_request_options_provider.py,sha256=SRROdPJZ5kuqHLOlkh115pWP9nDGfDxRYPgH9oD3hPo,1798
 airbyte_cdk/sources/declarative/requesters/request_options/interpolated_nested_request_input_provider.py,sha256=STVopTmEZaxmE-w_2zL6CYXFxq-2K2wDKGtWj9OYZyU,2360
 airbyte_cdk/sources/declarative/requesters/request_options/interpolated_request_input_provider.py,sha256=-X_sncjnw3N5ZyhlLMOI6vnWy2CM8drqPFOKgzDXTQg,2975
-airbyte_cdk/sources/declarative/requesters/request_options/interpolated_request_options_provider.py,sha256=ks4rCSdEKTX2bm8obDf-PzWggel1rQEwtu35-rQvqVk,8274
+airbyte_cdk/sources/declarative/requesters/request_options/interpolated_request_options_provider.py,sha256=fdGNgFlN3gowThp-NXOMfa5NtW2choFWpSAQEeVRtcw,8281
 airbyte_cdk/sources/declarative/requesters/request_options/request_options_provider.py,sha256=8YRiDzjYvqJ-aMmKFcjqzv_-e8OZ5QG_TbpZ-nuCu6s,2590
 airbyte_cdk/sources/declarative/requesters/request_path.py,sha256=S3MeFvcaQrMbOkSY2W2VbXLNomqt_3eXqVd9ZhgNwUs,299
 airbyte_cdk/sources/declarative/requesters/requester.py,sha256=T6tMx_Bx4iT-0YVjY7IzgRil-gaIu9n01b1iwpTh3Ek,5516
@@ -238,7 +239,7 @@ airbyte_cdk/sources/declarative/transformations/remove_fields.py,sha256=EwUP0SZ2
 airbyte_cdk/sources/declarative/transformations/transformation.py,sha256=4sXtx9cNY2EHUPq-xHvDs8GQEBUy3Eo6TkRLKHPXx68,1161
 airbyte_cdk/sources/declarative/types.py,sha256=yqx0xlZv_76tkC7fqJKefmvl4GJJ8mXbeddwVV8XRJU,778
 airbyte_cdk/sources/declarative/validators/__init__.py,sha256=_xccLn4QKQqR3CAwmCVOA7l6QuJd_Isoh6NsR8crM2U,663
-airbyte_cdk/sources/declarative/validators/dpath_validator.py,sha256=MEehshc7YiqUhTNm7qN6mN6JBdkQcYsoLPqAQYIE_-0,2179
+airbyte_cdk/sources/declarative/validators/dpath_validator.py,sha256=mo4eLir9aVLoZbi1v7_BP0u3yXFeRnDEAQSOZaSYM8s,2167
 airbyte_cdk/sources/declarative/validators/predicate_validator.py,sha256=Q4eVnclk1vYPvVF7XROG4MFEVkPYbYKEF8SUKs7P7-k,582
 airbyte_cdk/sources/declarative/validators/validate_adheres_to_schema.py,sha256=kjcuKxWMJEzpF4GiESITGMxBAXw6YZCAsgOQMgeBo4g,1085
 airbyte_cdk/sources/declarative/validators/validation_strategy.py,sha256=LwqUX89cFdHTM1-h6c8vebBA9WC38HYoGBvJfCZHr0g,467
@@ -423,9 +424,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.56.7.post1.dev15934698385.dist-info/LICENSE.txt,sha256=Wfe61S4BaGPj404v8lrAbvhjYR68SHlkzeYrg3_bbuM,1051
-airbyte_cdk-6.56.7.post1.dev15934698385.dist-info/LICENSE_SHORT,sha256=aqF6D1NcESmpn-cqsxBtszTEnHKnlsp8L4x9wAh3Nxg,55
-airbyte_cdk-6.56.7.post1.dev15934698385.dist-info/METADATA,sha256=XNRGPTDNL0yI3XUb481UieWDqg6UTjxyMNpsX_jTKhI,6413
-airbyte_cdk-6.56.7.post1.dev15934698385.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-airbyte_cdk-6.56.7.post1.dev15934698385.dist-info/entry_points.txt,sha256=AKWbEkHfpzzk9nF9tqBUaw1MbvTM4mGtEzmZQm0ZWvM,139
-airbyte_cdk-6.56.7.post1.dev15934698385.dist-info/RECORD,,
+airbyte_cdk-6.56.8.dist-info/LICENSE.txt,sha256=Wfe61S4BaGPj404v8lrAbvhjYR68SHlkzeYrg3_bbuM,1051
+airbyte_cdk-6.56.8.dist-info/LICENSE_SHORT,sha256=aqF6D1NcESmpn-cqsxBtszTEnHKnlsp8L4x9wAh3Nxg,55
+airbyte_cdk-6.56.8.dist-info/METADATA,sha256=-QMqJnVacR50jlwPgnpLNX4Rqnrn5AE4ykNkSXUI0l8,6392
+airbyte_cdk-6.56.8.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+airbyte_cdk-6.56.8.dist-info/entry_points.txt,sha256=AKWbEkHfpzzk9nF9tqBUaw1MbvTM4mGtEzmZQm0ZWvM,139
+airbyte_cdk-6.56.8.dist-info/RECORD,,