airbyte-cdk 6.56.7.post1.dev15934698385__tar.gz → 6.56.8__tar.gz

{airbyte_cdk-6.56.7.post1.dev15934698385 → airbyte_cdk-6.56.8}/PKG-INFO

@@ -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 → airbyte_cdk-6.56.8}/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-6.56.8/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-6.56.7.post1.dev15934698385 → airbyte_cdk-6.56.8}/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-6.56.7.post1.dev15934698385 → airbyte_cdk-6.56.8}/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-6.56.7.post1.dev15934698385 → airbyte_cdk-6.56.8}/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-6.56.7.post1.dev15934698385 → airbyte_cdk-6.56.8}/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-6.56.7.post1.dev15934698385 → airbyte_cdk-6.56.8}/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-6.56.7.post1.dev15934698385 → airbyte_cdk-6.56.8}/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-6.56.7.post1.dev15934698385 → airbyte_cdk-6.56.8}/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 → airbyte_cdk-6.56.8}/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.56.7.post1.dev15934698385"  # Version will be calculated dynamically.
+version = "6.56.8"  # Version will be calculated dynamically.
 
 [tool.poetry-dynamic-versioning]
 enable = false