docs: add cli module to api docs

[aaronsteers]

Adds new docs page for CLI:

https://airbytehq.github.io/PyAirbyte/airbyte/cli.html

Summary by CodeRabbit

• New Features

  • The cli module is now part of the public API, allowing direct imports from the airbyte namespace.

• Documentation

  • Enhanced documentation and formatting for CLI usage examples, improving clarity and consistency.
  • Updated docstrings to reflect the intended visibility of the cli function.

• Bug Fixes

  • Resolved circular import issues related to the cli module.

[coderabbitai]

📝 Walkthrough

📝 Walkthrough

Walkthrough

The pull request introduces modifications to the airbyte/__init__.py and airbyte/cli.py files, focusing on documentation improvements and module accessibility. The primary changes include adding the cli module to the top-level imports and __all__ list, and updating function signatures to explicitly return None. The documentation for CLI usage examples has been enhanced for clarity and consistency, ensuring users have a more straightforward understanding of how to use the PyAirbyte CLI commands.

Changes

File	Changes
airbyte/__init__.py	- Added cli to type-checking imports - Included cli in __all__ list
airbyte/cli.py	- Updated function signatures to explicitly return None for validate(), benchmark(), sync() - Improved CLI usage documentation - Added clarifying phrase "After installing PyAirbyte" - Reformatted CLI command examples

Sequence Diagram

sequenceDiagram
    participant User
    participant CLI as PyAirbyte CLI
    participant Connector as Airbyte Connector

    User->>CLI: Run command (validate/benchmark/sync)
    CLI->>Connector: Execute selected operation
    Connector-->>CLI: Return operation results
    CLI-->>User: Display results

Loading

A couple of friendly suggestions for the author:

1. The explicit -> None return type annotations seem a bit redundant since these functions already return None implicitly. Wdyt about removing them?
2. The documentation improvements look great! Have you considered adding more context about when and why someone might use these specific CLI commands? 😊

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d0f4d64 and d3ddf79.

📒 Files selected for processing (1)

• airbyte/__init__.py (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• airbyte/init.py

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[aaronsteers]

@coderabbitai review

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

airbyte/__init__.py (1)

Line range hint 1-196: Documentation update needed for CLI module

I notice that while we're adding the CLI module to the public API, it's not listed in the module documentation section with the other modules (like airbyte.cloud, airbyte.caches, etc.). Should we add a section about the CLI module to maintain consistency with the documentation structure?

Here's a suggested addition to the module list (around line 65):

 - **`airbyte.cloud`** - Working with Airbyte Cloud, including running jobs remotely.
+- **`airbyte.cli`** - Command Line Interface functionality for interacting with Airbyte from the terminal.
 - **`airbyte.caches`** - Working with caches, including how to inspect a cache and get data from it.

wdyt about adding this documentation to help users discover the CLI functionality?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ef7eb8f and d0f4d64.

📒 Files selected for processing (2)

• airbyte/__init__.py (2 hunks)
• airbyte/cli.py (5 hunks)

✅ Files skipped from review due to trivial changes (1)

• airbyte/cli.py