feat: Allow to set optional range

README.md

@@ -64,6 +64,7 @@ Setting | Required | Type             | Description |
 `sheet_id` | Required | String           | Your target google sheet id
 `output_name` | Optional | String           | Optionailly rename the stream and output file or table from the tap
 `child_sheet_name` | Optional | String           | Optionally choose a different sheet from your Google Sheet file
+`range` | Optional | String | Optionally choose a range of data from your Google Sheet file. Example: `B5:GH` (starts at B5 and goes to columns GH at the end of the sheet)
 `key_properties` | Optional | Array of Strings | Optionally choose primary key column(s) from your Google Sheet file. Example: `["column_one", "column_two"]`
 `sheets` | Optional | Array of Objects | Optionally provide a list of configs for each sheet/stream. See "Per Sheet Config" below. Overrides the `sheet_id` provided at the root level.
 
@@ -74,6 +75,7 @@ Setting | Required | Type | Description |
 `sheet_id` | Required | String | Your target google sheet id
 `output_name` | Optional | String | Optionailly rename the stream and output file or table from the tap
 `child_sheet_name` | Optional | String | Optionally choose a different sheet from your Google Sheet file
+`range` | Optional | String | Optionally choose a range of data from your Google Sheet file. Example: `B5:GH` (starts at B5 and goes to columns GH at the end of the sheet)
 `key_properties` | Optional | Array of Strings | Optionally choose primary key column(s) from your Google Sheet file. Example: `["column_one", "column_two"]`
 
 ### Environment Variable
@@ -85,6 +87,7 @@ These settings expand into environment variables of:
 - `TAP_GOOGLE_SHEETS_SHEET_ID`
 - `TAP_GOOGLE_SHEETS_OUTPUT_NAME`
 - `TAP_GOOGLE_SHEETS_CHILD_SHEET_NAME`
+- `TAP_GOOGLE_SHEETS_RANGE`
 - `TAP_GOOGLE_SHEETS_KEY_PROPERTIES`
 - `TAP_GOOGLE_SHEETS_SHEETS`
 
@@ -122,7 +125,7 @@ These settings expand into environment variables of:
 
 ## Roadmap
 
-- [ ] Add setting to optionally allow the selection of a range of data from a sheet. (Add an optional range setting).
+- [x] Add setting to optionally allow the selection of a range of data from a sheet. (Add an optional range setting).
 
 - [ ] Improve default behavior of a sheet with multiple columns of the same name and `target-postgres`.
 

tap_google_sheets/streams.py

@@ -24,7 +24,7 @@ class GoogleSheetsStream(GoogleSheetsBaseStream):
     @property
     def path(self):
         """Set the path for the stream."""
-        return f"/{self.stream_config['sheet_id']}/values/{self.child_sheet_name}"
+        return f"/{self.stream_config['sheet_id']}/values/{self.child_sheet_name}{'!'+self.stream_config['range'] if 'range' in self.stream_config else ''}"
 
     def parse_response(self, response: requests.Response) -> Iterable[dict]:
         """Parse response, build response back up into json, update stream schema."""

tap_google_sheets/tap.py

@@ -137,6 +137,20 @@ def get_first_visible_child_sheet_name(self, google_sheet_data: requests.Respons
 
         return sheet_in_sheet_name
 
+    @staticmethod
+    def get_first_line_range(stream_config):
+        """Get the range of the first line in the google sheet."""
+        first_line_range = "1:1"
+        range = stream_config.get("range")
+        if range:
+            start_column, start_line, end_column, end_line = re.findall(r"^([A-Za-z]*)(\d*):([A-Za-z]*)(\d*)$", range)[0]
+            start_column = start_column or ""
+            start_line = start_line or "1"
+            end_column = end_column or ""
+
+            first_line_range = start_column + start_line + ":" + end_column + start_line
+        return first_line_range
+
     def get_sheet_data(self, stream_config):
         """Get the data from the selected or first visible sheet in the google sheet."""
         config_stream = GoogleSheetsBaseStream(
@@ -147,7 +161,7 @@ def get_sheet_data(self, stream_config):
             + stream_config["sheet_id"]
             + "/values/"
             + stream_config.get("child_sheet_name", "")
-            + "!1:1",
+            + "!" + self.get_first_line_range(stream_config),
         )
 
         prepared_request = config_stream.prepare_request(None, None)

tap_google_sheets/tests/test_first_line_range.py

@@ -0,0 +1,27 @@
+import unittest
+
+from tap_google_sheets.tap import TapGoogleSheets
+
+
+class TestFirstLineRange(unittest.TestCase):
+
+    def test_first_line_range(self):
+        """Test first line range."""
+        test_pairs = [
+            ("", "1:1"),
+            ("1:1", "1:1"),
+            ("A1:G", "A1:G1"),
+            ("A5:G", "A5:G5"),
+            ("A6:GE56", "A6:GE6"),
+            ("A6:K38", "A6:K6"),
+            ("A4:", "A4:4"),
+            ("C:G", "C1:G1"),
+        ]
+        for test_input, expected in test_pairs:
+            stream_config = {"range": test_input}
+            self.assertEqual(expected, TapGoogleSheets.get_first_line_range(stream_config))
+
+    def test_empty_range(self):
+        """Test empty range."""
+        stream_config = {}
+        self.assertEqual("1:1", TapGoogleSheets.get_first_line_range(stream_config))