rabbit-bq-optimizer-airflow-plugin 1.0.0__tar.gz

rabbit_bq_optimizer_airflow_plugin-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

rabbit_bq_optimizer_airflow_plugin-1.0.0/PKG-INFO

@@ -0,0 +1,405 @@
+Metadata-Version: 2.4
+Name: rabbit-bq-optimizer-airflow-plugin
+Version: 1.0.0
+Summary: Airflow 2 plugin for Rabbit BigQuery Job Optimizer
+Home-page: https://github.com/followrabbit-ai/bq-job-optimizer-airflow-plugin
+Author: Rabbit Team
+Author-email: success@followrabbit.ai
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Framework :: Apache Airflow
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rabbit-bq-job-optimizer>=0.1.18
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Rabbit BigQuery Job Optimizer Airflow Plugin
+
+This Airflow plugin automatically optimizes BigQuery job configurations using the Rabbit API. It patches the BigQueryHook to intercept job configurations and optimize them before execution.
+
+## Features
+
+- Automatically intercepts all BigQuery job submissions
+- Optimizes job configurations via the Rabbit API
+- Routes `BigQueryInsertJobOperator` submits to an on-demand pool billing project when the optimizer sets `optimizedJob.jobReference.projectId`
+- Graceful fallback to original configuration if optimization fails
+- Comprehensive error handling and logging
+
+Already running an older version? See [Updating](#updating).
+
+## Installation
+
+### Option A: PyPI (recommended)
+
+1. Add the plugin and client to your Airflow environment:
+   - If using `requirements.txt`:
+     ```txt
+     rabbit-bq-job-optimizer==0.1.18
+     rabbit-bq-optimizer-airflow-plugin==1.0.0
+     ```
+   - If using `constraints.txt`:
+     ```txt
+     rabbit-bq-job-optimizer==0.1.18
+     rabbit-bq-optimizer-airflow-plugin==1.0.0
+     ```
+   - If using a custom Docker image, add to your Dockerfile:
+     ```dockerfile
+     RUN pip install rabbit-bq-job-optimizer==0.1.18 rabbit-bq-optimizer-airflow-plugin==1.0.0
+     ```
+
+   The plugin registers via Airflow's plugin entry point — no file copy into `plugins/` is required.
+
+2. Restart your Airflow scheduler, workers, and webserver to load the plugin. If you use deferrable `BigQueryInsertJobOperator`, restart the triggerer as well.
+
+### Option B: Copy into `plugins/`
+
+1. Add the Python client to your Airflow environment dependencies:
+
+   ```txt
+   rabbit-bq-job-optimizer==0.1.18
+   ```
+
+2. Copy the plugin file into your Airflow plugins directory:
+   ```bash
+   cp bq-job-optimizer-airflow-2/rabbit_bq_optimizer_plugin.py "$AIRFLOW_HOME/plugins/"
+   ```
+
+3. Restart your Airflow scheduler, workers, and webserver (and triggerer if using deferrable operators).
+
+## Updating
+
+### PyPI install
+
+Update to the new package versions in your environment dependencies:
+
+```txt
+rabbit-bq-job-optimizer==0.1.18
+rabbit-bq-optimizer-airflow-plugin==1.0.0
+```
+
+Apply the update using your platform's usual process, then restart Airflow components (including the triggerer if you use deferrable `BigQueryInsertJobOperator`). Your `rabbit_api` connection, `rabbit_bq_optimizer_config` variable, and DAGs are unchanged. If optimization fails, the plugin still submits the original job (fail-open).
+
+### Copy into `plugins/` (optional)
+
+If you installed via [Option B](#option-b-copy-into-plugins) and want to stay on the copy method, bump the client version in your environment dependencies and replace `rabbit_bq_optimizer_plugin.py` in your plugins location with the new file from this repo. Then restart Airflow components as above.
+
+### Switching from copy to PyPI
+
+If you previously deployed `rabbit_bq_optimizer_plugin.py` to your plugins location and are switching to the PyPI package, **remove that file** — the PyPI install loads via an entry point and the copied file causes duplicate plugin registration. On startup the plugin logs an error if both are present. When the file is writable, you can set `RABBIT_BQ_OPTIMIZER_REMOVE_LEGACY_PLUGIN=true` to remove it automatically on load.
+
+For pool billing routing, the Airflow service account also needs `roles/bigquery.jobUser` on the pool billing projects — contact Rabbit support for your project list. See [Pool billing project routing](#pool-billing-project-routing).
+
+## Configuration
+
+### 1. Create the Rabbit API connection
+
+For security reasons the Rabbit API key must be stored in an Airflow connection instead of a variable. The plugin expects a connection with ID `rabbit_api`:
+
+- `Conn Type`: `Generic` (or `HTTP`)
+- `Conn ID`: `rabbit_api`
+- `Password`: Rabbit API key (required)
+- `Extra` (optional):
+  ```json
+  {
+    "api_base_url": "https://api.followrabbit.ai/bq-job-optimizer"
+  }
+  ```
+  Only include `api_base_url` if you need to override the default Rabbit endpoint; otherwise it will fall back automatically.
+
+CLI example:
+
+```bash
+airflow connections add rabbit_api \
+    --conn-type generic \
+    --conn-password "<your-rabbit-api-key>" \
+    --conn-extra '{"api_base_url": "https://api.followrabbit.ai/bq-job-optimizer"}'
+```
+
+### 2. Set the optimization parameters
+
+The remaining optimizer configuration stays in an Airflow variable. Create a JSON configuration with the following structure:
+
+```json
+{
+    "default_pricing_mode": "on_demand",
+    "reservation_ids": [
+        "project:region.reservation-name1",
+        "project:region.reservation-name2"
+    ]
+}
+```
+
+### Configuration Fields
+
+- `default_pricing_mode` (required): The default pricing mode for jobs. Must be one of: `"on_demand"` or `"slot_based"`
+- `reservation_ids` (required): List of reservation IDs in the format "project:region.reservation-name"
+
+### Setting the Configuration
+
+You can set the configuration in two ways:
+
+1. Using the Airflow CLI:
+```bash
+airflow variables set rabbit_bq_optimizer_config '{
+    "default_pricing_mode": "on_demand",
+    "reservation_ids": [
+        "project:region.reservation-name1",
+        "project:region.reservation-name2"
+    ]
+}'
+```
+
+2. Through the Airflow UI:
+   - Go to Admin -> Variables
+   - Add a new variable named `rabbit_bq_optimizer_config`
+   - Paste the JSON configuration
+
+## End-to-End Test Plan
+
+### Local Testing
+
+A setup script `setup_local_test.sh` is provided in the root directory to help you spin up a local Airflow environment for testing.
+
+**Prerequisites:**
+- Python 3.8-3.12 (Airflow 2.9.1 requirement; the script will automatically detect and use a compatible version)
+- `pip`
+
+**Steps:**
+
+1. **Run the setup script:**
+   ```bash
+   ./setup_local_test.sh
+   ```
+   This script will:
+   - Create a virtual environment (if not present)
+  - Install Airflow using the official constraints file plus dependencies from `test_requirements.txt`
+   - Initialize the Airflow database
+   - Create an admin user
+   - Deploy the plugin and test DAG
+   - Configure the `rabbit_api` connection (with a dummy key)
+   - Configure the `rabbit_bq_optimizer_config` variable
+
+  *Note: The script installs Airflow using the official constraints file for your Python version so that binary wheels (including `google-re2`) are used. Additional dependencies (`rabbit-bq-job-optimizer`, `apache-airflow-providers-google`, `google-cloud-bigquery`, etc.) are installed with the same constraints to match the Airflow release.*
+
+2. **Run the test DAG:**
+   The setup script automatically deploys `test_dag.py` to the DAGs directory.
+
+   Execute the test DAG:
+   ```bash
+   source venv/bin/activate
+   export AIRFLOW_HOME=$(pwd)/airflow_home
+   airflow dags test rabbit_optimizer_test $(date +%Y-%m-%d)
+   ```
+
+3. **Verify Results:**
+   Check the logs for the following:
+   - `Rabbit BQ Optimizer: patching BigQueryHook.insert_job` (scheduler logs at startup)
+   - `Rabbit BQ Optimizer: patching BigQueryInsertJobOperator._submit_job` (scheduler logs at startup)
+   - `Rabbit BQ Optimizer: optimization result=...` at DEBUG on job submit (or failure if using dummy key/URL)
+
+4. **Run automated tests:**
+   After setup, you can run automated tests to validate the plugin:
+
+   **Test connection loading:**
+   ```bash
+   source venv/bin/activate
+   export AIRFLOW_HOME=$(pwd)/airflow_home
+   cd bq-job-optimizer-airflow-2
+   python test_plugin_connection.py
+   ```
+   This verifies that the plugin can load credentials from the Airflow connection.
+
+   **Test DAG execution (full integration):**
+   ```bash
+   source venv/bin/activate
+   export AIRFLOW_HOME=$(pwd)/airflow_home
+   cd bq-job-optimizer-airflow-2
+   python test_dag_execution.py
+   ```
+   This simulates a DAG execution and verifies that:
+   - The plugin intercepts BigQuery jobs
+   - The Rabbit optimization API is called with connection credentials
+   - The optimized configuration is used
+
+   **Test plugin optimization (unit, no real BQ):**
+   ```bash
+   source venv/bin/activate
+   export AIRFLOW_HOME=$(pwd)/airflow_home
+   python -m unittest bq-job-optimizer-airflow-2/test_plugin_optimization.py -v
+   ```
+
+5. **Cleanup (optional):**
+   To remove the test environment (venv and airflow_home directories):
+   ```bash
+   ./setup_local_test.sh --clean
+   ```
+   Or use the short form:
+   ```bash
+   ./setup_local_test.sh -c
+   ```
+
+### Manual Validation Steps
+
+1. **Connection setup**
+   - Create the `rabbit_api` connection as described above.
+   - Verify the password is populated and (optionally) the base URL override is correct by running `airflow connections get rabbit_api`.
+
+2. **Variable setup**
+   - Set the `rabbit_bq_optimizer_config` variable using the sample JSON (without the API key).
+   - Include at least one reservation ID and confirm the `default_pricing_mode` is valid.
+
+3. **DAG validation**
+   - Deploy the plugin file to `$AIRFLOW_HOME/plugins`.
+   - Restart the scheduler/webserver/workers so the patch is applied.
+   - Trigger a DAG that uses `BigQueryInsertJobOperator` (or any BigQuery operator).
+
+4. **Positive path (connection + variable present)**
+   - Confirm in the scheduler logs at startup that the plugin logs `patching BigQueryHook.insert_job` and `patching BigQueryInsertJobOperator._submit_job`.
+   - Validate that the BigQuery job request reaches Rabbit (check Rabbit logs or enable DEBUG for `Rabbit BQ Optimizer: optimization result=...`).
+   - For a query with historical data/reservations, verify the resulting BigQuery job uses the optimized configuration.
+
+5. **Missing connection safety net**
+   - Temporarily rename/delete the Airflow connection and re-run the DAG.
+   - The scheduler logs should show `Failed to load Rabbit API connection` and the job should proceed without optimization (ensures graceful fallback).
+
+6. **Custom base URL regression**
+   - Set `api_base_url` in the connection extras to a staging endpoint (or use schema/host).
+   - Trigger a DAG and confirm via Rabbit logs/network traces that the request hits the custom endpoint.
+
+7. **Compatibility check**
+   - Ensure the environment installs the latest `rabbit-bq-job-optimizer` package (e.g., `pip install -U rabbit-bq-job-optimizer`).
+   - Run unit tests or a smoke DAG run to confirm no API contract regressions with the service.
+
+## Usage
+
+The plugin works automatically with any BigQuery operator. No additional configuration is needed in your DAGs:
+
+```python
+from airflow.providers.google.cloud.operators.bigquery import BigQueryInsertJobOperator
+
+# The plugin will automatically optimize this job
+insert_job = BigQueryInsertJobOperator(
+    task_id="insert_query_job",
+    configuration={
+        "query": {
+            "query": "SELECT * FROM `project.dataset.table`",
+            "useLegacySql": False
+        }
+    }
+)
+```
+
+### Pool billing project routing
+
+When the optimizer returns a pool billing project in
+`optimizedJob.jobReference.projectId`, jobs submitted through
+`BigQueryInsertJobOperator` run and poll on that project. The plugin briefly
+links the operator to the hook during `_submit_job` so `operator.project_id`
+and the BigQuery `jobs.insert` call use the same billing project.
+
+Direct `BigQueryHook.insert_job` calls still receive the optimized
+configuration but keep the original `project_id`. Use
+`BigQueryInsertJobOperator` in DAGs when you need pool billing project
+routing with deferrable tasks.
+
+If the optimizer response has no `jobReference.projectId` (for example
+reservation-only assignment), the operator keeps its configured source
+`project_id`.
+
+### Job labels
+
+Optimized jobs include labels you can query in BigQuery
+(`INFORMATION_SCHEMA.JOBS_BY_*`) to confirm how each submit was handled:
+
+| Label | Values | Meaning |
+|-------|--------|---------|
+| `rabbit-source-project` | GCP project id | Project the job was submitted from (your DAG / operator `project_id`) |
+| `rabbit-pool-project` | GCP project id | Pool billing project recommended by the optimizer (present only when a pool was assigned) |
+| `rabbit-pool-routing` | `applied` \| `skipped` \| `none` | `applied`: `BigQueryInsertJobOperator` submitted on `rabbit-pool-project`; `skipped`: pool recommended but submit stayed on the source project (typically a direct hook call); `none`: no pool billing project in the optimizer response |
+
+## Error Handling
+
+The plugin includes comprehensive error handling for:
+- Missing or invalid configuration
+- Missing required fields
+- Empty reservation IDs list
+- API errors
+
+In all error cases, the plugin will log a warning and proceed with the original job configuration.
+
+## Troubleshooting
+
+```
+Broken plugin: `No module named 'rabbit_bq_job_optimizer'` — install `rabbit-bq-optimizer-airflow-plugin` (or `rabbit-bq-job-optimizer`) in the Airflow environment and restart.
+```
+
+If you see this error, it means the rabbit-bq-job-optimizer package is missing from your Airflow environment. Install it by adding the package (https://pypi.org/project/rabbit-bq-job-optimizer/) to your Airflow requirements or environment.
+
+```
+[2025-06-15, 17:25:20 UTC] {rabbit_bq_optimizer_plugin.py:82} WARNING - Rabbit BQ Optimizer: config error: 'Variable rabbit_bq_optimizer_config does not exist'. Using original job.
+```
+
+If you see this error, it means the Airflow variable `rabbit_bq_optimizer_config` is not set or has invalid content. Make sure you have:
+
+1. Created the variable named exactly `rabbit_bq_optimizer_config`
+2. Set valid JSON content that includes all required fields:
+   ```json
+   {
+       "default_pricing_mode": "on_demand",
+       "reservation_ids": [
+           "project:us-central1.reservation-name1",
+           "project:us-east1.reservation-name2"
+       ]
+   }
+   ```
+3. Verified the JSON is properly formatted without any syntax errors
+
+## Development
+
+### Pre-commit Hooks
+
+This repository uses pre-commit hooks to ensure code quality. To set them up:
+
+```bash
+# Install pre-commit
+pip install pre-commit
+
+# Install the hooks
+pre-commit install
+
+# (Optional) Run hooks on all files
+pre-commit run --all-files
+```
+
+The hooks will automatically:
+- **Auto-fix** formatting with Black (CI checks formatting)
+- **Auto-fix** linting issues with Ruff (CI checks linting)
+- Check for common issues (trailing whitespace, large files, etc.)
+
+**Note**: Pre-commit hooks auto-fix issues for convenience, while CI runs in check-only mode to ensure nothing slips through.
+
+### CI/CD
+
+GitHub Actions automatically runs on every push and pull request:
+- **Linting and Formatting**: Checks code style with Black and Ruff
+- **Tests**: Runs test suite on Python 3.9, 3.10, 3.11, and 3.12
+
+## Uninstalling
+
+1. Remove the plugin file from your Airflow plugins directory
+2. Restart Airflow
+
+## Support
+
+For questions, API endpoint details, API key, or any issues, contact the Rabbit support team at success@followrabbit.ai

rabbit_bq_optimizer_airflow_plugin-1.0.0/README.md

@@ -0,0 +1,16 @@
+This repository contains the source code for Rabbit's Airflow plugins, specifically focusing on BigQuery job optimization. These plugins are designed to enhance Apache Airflow's capabilities when working with BigQuery, providing optimized job execution and cost saving.
+
+## Airflow 2 Plugin Highlights
+
+- Patches the BigQuery hook to transparently send job configurations to the Rabbit Job Optimizer service.
+- Authenticates via the official `rabbit-bq-job-optimizer` Python client (install the latest version for compatibility).
+- Retrieves the Rabbit API key (and optional base URL override) from the Airflow connection `rabbit_api` so secrets stay out of plain-text variables.
+- Reads optimization parameters (pricing mode, reservation IDs, etc.) from the `rabbit_bq_optimizer_config` Airflow variable.
+
+Refer to `bq-job-optimizer-airflow-2/README.md` for installation, configuration, and the end-to-end test plan.
+
+## PyPI
+
+The Airflow 2 plugin is published as [`rabbit-bq-optimizer-airflow-plugin`](https://pypi.org/project/rabbit-bq-optimizer-airflow-plugin/). Release with `./publish_to_pypi.sh` (same flow as the [python-bq-job-optimizer](https://github.com/followrabbit-ai/python-bq-job-optimizer) client).
+
+For more information about Rabbit and our data platform, visit [https://followrabbit.ai/](https://followrabbit.ai/).