move docstring

Author: aaronsteers

airbyte_cdk/cli/build/__init__.py

@@ -1,41 +0,0 @@
-"""Airbyte CDK Build Command.
-
-The `airbyte-cdk-build` command provides a simplified way to build connector Docker images without requiring the full Airbyte CI pipeline.
-
-
-```bash
-pip install airbyte-cdk
-
-pipx run airbyte-cdk-build [arguments]
-```
-
-
-```bash
-airbyte-cdk-build /path/to/connector
-
-airbyte-cdk image build /path/to/connector
-
-airbyte-cdk image build /path/to/connector --tag custom_tag
-
-airbyte-cdk image build /path/to/connector --no-verify
-
-airbyte-cdk image build /path/to/connector --verbose
-```
-
-
-- `connector_dir`: Path to the connector directory (required)
-- `--tag`: Tag to apply to the built image (default: "dev")
-- `--no-verify`: Skip verification of the built image
-- `--verbose`, `-v`: Enable verbose logging
-
-
-The command reads the connector's metadata from the `metadata.yaml` file, builds a Docker image using the connector's Dockerfile, and verifies the image by running the `spec` command. The image is tagged according to the repository name specified in the metadata and the provided tag.
-
-This command is designed to be a simpler alternative to the `airbyte-ci build` command, using Docker directly on the host machine instead of Dagger.
-"""
-
-from airbyte_cdk.cli.build._run import run
-
-__all__ = [
-    "run",
-]

airbyte_cdk/cli/commands/image.py

@@ -1,4 +1,41 @@
-"""Image-related commands for the Airbyte CDK CLI."""
+"""Airbyte CDK 'image' commands.
+
+The `airbyte-cdk` command provides a simplified way to build connector Docker images without requiring the full Airbyte CI pipeline.
+
+```bash
+pip install airbyte-cdk
+
+pipx run airbyte-cdk image [arguments]
+```
+
+
+```bash
+airbyte-cdk image build /path/to/connector
+
+airbyte-cdk image build /path/to/connector --tag custom_tag
+
+airbyte-cdk image build /path/to/connector --no-verify
+
+airbyte-cdk image build /path/to/connector --verbose
+```
+
+
+- `connector_dir`: Path to the connector directory (required)
+- `--tag`: Tag to apply to the built image (default: "dev")
+- `--no-verify`: Skip verification of the built image
+- `--verbose`, `-v`: Enable verbose logging
+
+
+The command reads the connector's metadata from the `metadata.yaml` file, builds a Docker image using the connector's Dockerfile, and verifies the image by running the `spec` command. The image is tagged according to the repository name specified in the metadata and the provided tag.
+
+This command is designed to be a simpler alternative to the `airbyte-ci build` command, using Docker directly on the host machine instead of Dagger.
+"""
+
+from airbyte_cdk.cli.build._run import run
+
+__all__ = [
+    "run",
+]
 
 import sys
 from pathlib import Path
@@ -23,12 +60,18 @@ def image() -> None:
 
 @image.command()
 @click.argument(
-    "connector_dir", type=click.Path(exists=True, file_okay=False, dir_okay=True, path_type=Path)
+    "connector_directory",
+    type=click.Path(exists=True, file_okay=False, dir_okay=True, path_type=Path),
 )
 @click.option("--tag", default="dev", help="Tag to apply to the built image (default: dev)")
 @click.option("--no-verify", is_flag=True, help="Skip verification of the built image")
 @click.option("--verbose", "-v", is_flag=True, help="Enable verbose logging")
-def build(connector_dir: Path, tag: str, no_verify: bool, verbose: bool) -> None:
+def build(
+    connector_directory: Path,
+    tag: str = "dev",
+    no_verify: bool = False,
+    verbose: bool = False,
+) -> None:
     """Build a connector Docker image.
 
     This command builds a Docker image for a connector, using either
@@ -44,7 +87,7 @@ def build(connector_dir: Path, tag: str, no_verify: bool, verbose: bool) -> None
         sys.exit(1)
 
     try:
-        metadata = read_metadata(connector_dir)
+        metadata = read_metadata(connector_directory)
         click.echo(f"Connector: {metadata.dockerRepository}")
         click.echo(f"Version: {metadata.dockerImageTag}")