fix(connector_sdk) : Adding preinstall package link#10
fix(connector_sdk) : Adding preinstall package link#10fivetran-JenasVimal wants to merge 4 commits into
Conversation
|
deleted |
There was a problem hiding this comment.
Pull request overview
This PR updates multiple Connector SDK example README.md files to align more closely with the repository’s README template (formatting, “Getting started” fivetran init instructions, and standardized notes), and updates the template to link to the official pre-installed packages documentation.
Changes:
- Adds/standardizes
fivetran init --template ...instructions and note formatting across many example READMEs. - Normalizes README formatting (spacing, code block language hints, sentence case tweaks).
- Updates
_template_connector/README_template.mdto link to the official pre-installed packages list.
Reviewed changes
Copilot reviewed 36 out of 36 changed files in this pull request and generated 49 comments.
Show a summary per file
| File | Description |
|---|---|
zigpoll/README.md |
Formatting + init instructions + requirements note updates |
yugabyte_db/README.md |
Formatting + init instructions + requirements note updates |
vercel/README.md |
Formatting + init instructions + requirements note updates |
veeva_vault/session_id_auth/README.md |
Formatting + init instructions + requirements note updates |
veeva_vault/basic_auth/README.md |
Formatting + init instructions + requirements note updates |
tulip_interfaces/README.md |
Adds Requirements section + init instructions + note/typo fixes |
toast/README.md |
Restructures README sections; adds init instructions; adjusts headings/notes |
timescale_db/README.md |
Formatting + init instructions + requirements note updates |
tidb/README.md |
Formatting + init instructions + requirements note updates |
teradata/README.md |
Formatting + init instructions + requirements note updates |
talon_one/README.md |
Formatting + init instructions + requirements note updates |
supabase/README.md |
Formatting + init instructions + requirements note updates |
suitedash/README.md |
Formatting + init instructions + requirements note updates |
status_cake/README.md |
Formatting + init instructions + requirements note updates |
sql_server/README.md |
Formatting + init instructions + requirements note updates |
solace/README.md |
Formatting + init instructions + requirements note updates |
snipeitapp/README.md |
Adds init instructions + note formatting + table header casing |
smartsheets/README.md |
Formatting + init instructions + requirements note updates |
similarweb/README.md |
Adds required sections/formatting; init instructions; code block hinting |
sensource/README.md |
Formatting + init instructions + requirements note updates |
sensor_tower/README.md |
Adds required sections/formatting; init instructions; code block hinting |
sendcloud/README.md |
Adds init instructions + requirements note updates + path formatting |
sap_hana_sql/README.md |
Formatting + init instructions + requirements note updates |
sap_ariba/README.md |
Formatting + init instructions + requirements note updates |
sam_gov/README.md |
Adds Requirements file section + init instructions + note formatting |
s3_csv_validation/README.md |
Formatting + init instructions + requirements note updates |
rethink_db/README.md |
Formatting + init instructions + requirements note updates |
resend/README.md |
Formatting + init instructions + requirements note updates |
redshift/using_unload/README.md |
Formatting + init instructions + requirements note updates |
redshift/simple_redshift_connector/README.md |
Formatting + init instructions + requirements note updates |
redshift/large_data_volume/README.md |
Formatting + init instructions + requirements note updates |
redis/README.md |
Formatting + init instructions + requirements note updates |
raven_db/README.md |
Formatting + init instructions + requirements note updates |
rabbitmq/README.md |
Formatting + init instructions + requirements note updates |
quest_db/README.md |
Adds init instructions + requirements note updates |
_template_connector/README_template.md |
Replaces hard-coded pre-installed package list with docs link |
Comments suppressed due to low confidence (1)
similarweb/README.md:65
- This README references
test.pyfor theupdatefunction, but this example folder doesn’t contain atest.pyfile (the main implementation is inconnector.py). Please update the reference so readers can find the correct code.
## Authentication
The connector uses an API key for authentication with Similarweb. You can obtain your API key from your Similarweb account dashboard. The key should be provided in the `configuration.json` file as the value for the `api_key` key. (See `update` function in `test.py`)
| The `requirements.txt` file specifies Python libraries required by the connector. This connector uses only the pre-installed packages in the Fivetran environment. | ||
|
|
||
| Note: The `fivetran_connector_sdk:latest` and `requests:latest` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`. | ||
| > Note: The `fivetran_connector_sdk:latest`, `requests:2.33.0`, `grpcio:1.78.0`, and `grpcio-tools:1.78.0` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`. | ||
|
|
There was a problem hiding this comment.
The note in the Requirements file section hard-codes specific “pre-installed” package versions. This is likely to become outdated and is inconsistent with the repository template (_template_connector/README_template.md:93), which now links to the official pre-installed packages list. Consider replacing this with the docs link instead of listing versions.
| The connector requires the `psycopg2_binary` package for PostgreSQL-compatible database connectivity with YugabyteDB. | ||
|
|
||
| ``` | ||
| psycopg2_binary==2.9.11 | ||
| ``` | ||
|
|
||
| Note: The `fivetran_connector_sdk:latest` and `requests:latest` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`. | ||
| > Note: The `fivetran_connector_sdk:latest`, `requests:2.33.0`, `grpcio:1.78.0`, and `grpcio-tools:1.78.0` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`. | ||
|
|
There was a problem hiding this comment.
The note in the Requirements file section hard-codes specific “pre-installed” package versions. This can go stale and is inconsistent with the updated template (_template_connector/README_template.md:93) which links to the official list. Consider switching this note to the docs link instead of listing versions.
| ## Requirements file | ||
|
|
||
| The connector uses the `requests` library for HTTP communication, which is pre-installed in the Fivetran environment. | ||
|
|
||
| Note: The `fivetran_connector_sdk:latest` and `requests:latest` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`. | ||
| > Note: The `fivetran_connector_sdk:latest`, `requests:2.33.0`, `grpcio:1.78.0`, and `grpcio-tools:1.78.0` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`. | ||
|
|
There was a problem hiding this comment.
The note in the Requirements file section hard-codes specific “pre-installed” package versions. This is prone to becoming outdated and differs from the updated template (_template_connector/README_template.md:93) which points to the official pre-installed packages list. Consider replacing this with the docs link.
| @@ -1,10 +1,32 @@ | |||
| # Toast Fivetran Connector | |||
| # Toast Fivetran Connector Example | |||
There was a problem hiding this comment.
This README’s H1 doesn’t follow the required format “# Connector Example” from the repository README template (it currently includes extra wording). Please update the H1 to match the standard format so all examples are consistent.
| # Toast Fivetran Connector Example | |
| # Toast Connector Example |
| - Domain to connect to (e.g., `api.toasttab.com`) | ||
| - A Fernet key (`key`) for encrypting access tokens | ||
| - `initialSyncStart` ISO timestamp to define the start of sync window | ||
| - [Supported Python versions](https://github.com/fivetran/fivetran-csdk-connectors/blob/main/README.md#requirements) |
There was a problem hiding this comment.
The Requirements section is missing the standard operating system bullets required by the repository README template. Please add the OS list (Windows/macOS/Linux) in the same format used in other connectors’ READMEs.
| - [Supported Python versions](https://github.com/fivetran/fivetran-csdk-connectors/blob/main/README.md#requirements) | |
| - [Supported Python versions](https://github.com/fivetran/fivetran-csdk-connectors/blob/main/README.md#requirements) | |
| - Operating system: | |
| - Windows: 10 or later (64-bit only) | |
| - macOS: 13 (Ventura) or later (Apple Silicon [arm64] or Intel [x86_64]) | |
| - Linux: Distributions such as Ubuntu 20.04 or later, Debian 10 or later, or Amazon Linux 2 or later (arm64 or x86_64) |
| The connector uses the `pika` library (version 1.3.2) for connecting to and consuming messages from RabbitMQ. | ||
|
|
||
| Note: The `fivetran_connector_sdk:latest` and `requests:latest` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`. | ||
| > Note: The `fivetran_connector_sdk:latest`, `requests:2.33.0`, `grpcio:1.78.0`, and `grpcio-tools:1.78.0` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`. |
There was a problem hiding this comment.
The note in the Requirements file section hard-codes specific “pre-installed” package versions. This is likely to become outdated; the updated template (_template_connector/README_template.md:93) now links to the official pre-installed packages list. Consider using that link here as well.
| > Note: The `fivetran_connector_sdk:latest`, `requests:2.33.0`, `grpcio:1.78.0`, and `grpcio-tools:1.78.0` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`. | |
| > Note: Some packages are pre-installed in the Fivetran environment. Refer to the official [pre-installed packages list](https://fivetran.com/docs/connectors/connector-sdk/technical-reference#pre-installed-packages) and do not declare those packages in your `requirements.txt` to avoid dependency conflicts. |
| This connector does not require a `requirements.txt` file as it only uses standard library modules and the `requests` library, which is pre-installed in the Fivetran environment. | ||
|
|
||
| Note: The `fivetran_connector_sdk:latest` and `requests:latest` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`. | ||
| > Note: The `fivetran_connector_sdk:latest`, `requests:2.33.0`, `grpcio:1.78.0`, and `grpcio-tools:1.78.0` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`. |
There was a problem hiding this comment.
The note in the Requirements file section hard-codes specific “pre-installed” package versions. This is likely to become outdated; the updated template (_template_connector/README_template.md:93) now links to the official pre-installed packages list. Consider using that link here as well.
| > Note: The `fivetran_connector_sdk:latest`, `requests:2.33.0`, `grpcio:1.78.0`, and `grpcio-tools:1.78.0` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`. | |
| > Note: For the current list of packages pre-installed in the Fivetran environment, refer to the [official pre-installed packages documentation](https://fivetran.com/docs/connectors/connector-sdk/technical-reference#pre-installed-packages). To avoid dependency conflicts, do not declare those packages in your `requirements.txt`. |
| The `requirements.txt` file lists additional Python dependencies used by the connector. This example does not require any external libraries beyond those preinstalled in the Fivetran execution environment. | ||
|
|
||
| > Note: The `fivetran_connector_sdk:latest`, `requests:2.33.0`, `grpcio:1.78.0`, and `grpcio-tools:1.78.0` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`. |
There was a problem hiding this comment.
The note in the Requirements file section hard-codes specific “pre-installed” package versions. This is likely to become outdated; the updated template (_template_connector/README_template.md:93) now links to the official pre-installed packages list. Consider using that link here as well.
| The `requirements.txt` file lists additional Python dependencies used by the connector. This example does not require any external libraries beyond those preinstalled in the Fivetran execution environment. | |
| > Note: The `fivetran_connector_sdk:latest`, `requests:2.33.0`, `grpcio:1.78.0`, and `grpcio-tools:1.78.0` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`. | |
| The `requirements.txt` file lists additional Python dependencies used by the connector. This example does not require any external libraries beyond those pre-installed in the Fivetran execution environment. | |
| > Note: For the current list of pre-installed packages in the Fivetran environment, refer to the official documentation. To avoid dependency conflicts, do not declare pre-installed packages such as `fivetran_connector_sdk` and `requests` in your `requirements.txt`. |
| ## Requirements file | ||
|
|
||
| Note: Ensure that the `configuration.json` file is not checked into version control to protect sensitive information. | ||
| > Note: The `fivetran_connector_sdk:latest`, `requests:2.33.0`, `grpcio:1.78.0`, and `grpcio-tools:1.78.0` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`. | ||
|
|
There was a problem hiding this comment.
The note in the Requirements file section hard-codes specific “pre-installed” package versions. This is likely to become outdated; the updated template (_template_connector/README_template.md:93) now links to the official pre-installed packages list. Consider using that docs link here instead of listing versions.
| ## Requirements file | ||
|
|
||
| ## How it works | ||
| > Note: The `fivetran_connector_sdk:latest`, `requests:2.33.0`, `grpcio:1.78.0`, and `grpcio-tools:1.78.0` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`. |
There was a problem hiding this comment.
The Requirements file note lists specific “pre-installed” package versions. This is prone to becoming outdated and is inconsistent with the updated template (_template_connector/README_template.md:93) which links to the official pre-installed packages list. Consider replacing this hard-coded list with the docs link.
| > Note: The `fivetran_connector_sdk:latest`, `requests:2.33.0`, `grpcio:1.78.0`, and `grpcio-tools:1.78.0` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`. | |
| Note: Some packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare those packages in your `requirements.txt`. For the current list of pre-installed packages, refer to the [official documentation](https://fivetran.com/docs/connectors/connector-sdk/technical-reference#pre-installed-packages). |
Description of Change
Added a link for the pre-installed packages instead of mentioning the packages
Testing
No testing
Checklist
Some tips and links to help validate your PR:
fivetran debugcommand.