search

airbytehq / PyAirbyte

PyAirbyte brings the power of Airbyte to every Python developer.
https://docs.airbyte.com/pyairbyte
Other
234 stars 41 forks source link

Feat: Add new PyAirbyte CLI for connector validation and benchmarking; add helper functions `get_noop_destination()` and `get_benchmark_source()` #411

Closed aaronsteers closed 1 month ago

aaronsteers commented 1 month ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago
📝 Walkthrough
📝 Walkthrough ## Walkthrough The pull request introduces several modifications to the `pyproject.toml` file, primarily focused on dependency management and project configuration. The project name is updated from "airbyte" to "PyAirbyte," while maintaining a dynamic versioning system set to "0.0.0." Key changes in dependencies include updates to various libraries, adjustments to entry points, and enhancements to testing and linting configurations. ## Changes | File | Change Summary | |-----------------------------|----------------------------------------------------------------------------------------------------| | pyproject.toml | - Project name changed from "airbyte" to "PyAirbyte".
- Dynamic version remains "0.0.0".
- Entry points updated to `pyairbyte` and `pyab` pointing to `airbyte.cli:cli`.
- Updated dependencies: `sqlalchemy-bigquery` (<3.13), `pytest`, `mypy`, `ruff`, `docker`, `faker`, `pytest-docker`, `pytest-mypy`, `pytest-mock`, `coverage`, `pytest-timeout`, `viztracer`, and added `sqlalchemy2-stubs`.
- Modified `tool.pytest.ini_options` for test markers and warning filters.
- Expanded `tool.ruff` section with new linting rules and configurations. | | airbyte/__init__.py | - Commented out `cli` module to prevent circular imports.
- Updated `__all__` list to exclude `"cli"`. | | airbyte/cli.py | - Added CLI commands: `validate` and `benchmark`.
- Implemented internal functions for resolving source and destination jobs. | | airbyte/destinations/__init__.py | - Added `get_noop_destination()` method to public API. | | airbyte/destinations/util.py | - Added `get_noop_destination()` function for no-op destination. | | airbyte/sources/__init__.py | - Added `get_benchmark_source` to public API. | | airbyte/sources/util.py | - Deprecated `get_connector()` function, added `get_benchmark_source()` for generating dummy records. | | examples/run_perf_test_reads.py | - Changed command-line argument structure, replacing `-e` with `-n` for record counts and updated related logic. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant User participant CLI participant Dependencies User->>CLI: Run command (pyairbyte or pyab) CLI->>Dependencies: Load required libraries Dependencies-->>CLI: Libraries loaded CLI->>User: Execute command and return results ``` What do you think about this diagram? Does it capture the essence of the changes effectively?

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): > ‼️ **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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.