getredash/redash

Google Spreadsheets worksheet by title cleanup/refactor

Open

#6,409 opened on Aug 31, 2023

View on GitHub
 (5 comments) (3 reactions) (1 assignee)Python (24,845 stars) (4,236 forks)batch import
enhancementgood first issue

Description

In #5334 , I left a few comments about future work on the "fetch worksheet by title" functionality for the google spreadsheets query runner. We should address those, namely:

  • don't use mixed-type variables
  • allow for non-quoted worksheet titles (single word)
  • verify 0/1 indexing of worksheet numbers, and add comment if it differs

Contributor guide

Tech stack
python
Domain
backendapi
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Python knowledgeFamiliarity with Redash plugin structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Review the comments and code changes in PR #5334 to understand the existing implementation for fetching worksheet by title. Check the mixed type variables and decide on a consistent type. Look at how worksheet titles are currently quoted; extend support for non quoted single word titles. Verify the 0/1 indexing of worksheet numbers by examining the Google Sheets API documentation and the current usage in the codebase, then add clarifying comments.