RFC00157: Integrating Audio Metadata into Main Google Sheets
Named Concepts
Audio Segment: A specific portion of audio, identified by an audio ID, length, and transcription.
Department: A categorization of audio segments based on their origin or type.
Metadata: Additional data about each audio segment, such as creator, date created, and format.
Summary
This RFC outlines a task to enhance an existing Google Sheet (referred to as the Main Sheet), which contains information about various audio segments. The task involves adding metadata for each audio segment by extracting this information from department-specific Google Sheets. The audio ID, which includes the department name followed by the audio ID itself, will be used to identify the correct department sheet and corresponding metadata row.
Dependencies
Google Sheets API for programmatic access and manipulation of the sheets.
A programming language capable of interfacing with the Google Sheets API (e.g., Python).
Libraries/packages for handling Google API authentication and interaction (e.g., google-auth, google-api-python-client
Infrastructures
Include all the infrastructure required for running the task, such as S3 bucket, EC2 server, etc.
Design Illustrations
Justification
The proposed design was selected for its straightforward approach to mapping between audio segments and their metadata, minimizing complexity and potential for error. This method allows for easy expansion or modification should new departments or metadata fields be added in the future.
Why was the currently proposed design selected over alternatives?
Simplicity: Directly maps audio IDs to department sheets without requiring a complex intermediary structure.
Scalability: Easily accommodates new departments or audio segments by adding new sheets or rows.
Testing
Unit Testing: For individual functions, such as extracting department ID, finding the correct row in department sheets, and appending metadata.
Integration Testing: To ensure the entire workflow functions as expected, from reading the Main Sheet to updating it with metadata.
End-to-End Testing: With a copy of the actual Google Sheets to simulate the real environment and verify the process does not affect unintended parts of the sheets.
Implementation Steps
List all the steps involved during implementation.
[ ] OpenPecha/stt_catalog_merger#1
Estimated time: 1 hour
Actual time:
[ ] OpenPecha/stt_catalog_merger#2
Estimated time: 1 hour
Actual time:
[ ] OpenPecha/stt_catalog_merger#3
Estimated time: 1 hour
Actual time:
[ ] OpenPecha/stt_catalog_merger#4
Estimated time: 1 hour
Actual time:
[ ] OpenPecha/stt_catalog_merger#5
Estimated time: 1 hour
Actual time:
RFC00157: Integrating Audio Metadata into Main Google Sheets
Named Concepts
Audio Segment: A specific portion of audio, identified by an audio ID, length, and transcription. Department: A categorization of audio segments based on their origin or type. Metadata: Additional data about each audio segment, such as creator, date created, and format.
Summary
This RFC outlines a task to enhance an existing Google Sheet (referred to as the Main Sheet), which contains information about various audio segments. The task involves adding metadata for each audio segment by extracting this information from department-specific Google Sheets. The audio ID, which includes the department name followed by the audio ID itself, will be used to identify the correct department sheet and corresponding metadata row.
Dependencies
Google Sheets API for programmatic access and manipulation of the sheets. A programming language capable of interfacing with the Google Sheets API (e.g., Python). Libraries/packages for handling Google API authentication and interaction (e.g., google-auth, google-api-python-client
Infrastructures
Include all the infrastructure required for running the task, such as S3 bucket, EC2 server, etc.
Design Illustrations
Justification
The proposed design was selected for its straightforward approach to mapping between audio segments and their metadata, minimizing complexity and potential for error. This method allows for easy expansion or modification should new departments or metadata fields be added in the future. Why was the currently proposed design selected over alternatives? Simplicity: Directly maps audio IDs to department sheets without requiring a complex intermediary structure. Scalability: Easily accommodates new departments or audio segments by adding new sheets or rows.
Testing
Unit Testing: For individual functions, such as extracting department ID, finding the correct row in department sheets, and appending metadata. Integration Testing: To ensure the entire workflow functions as expected, from reading the Main Sheet to updating it with metadata. End-to-End Testing: With a copy of the actual Google Sheets to simulate the real environment and verify the process does not affect unintended parts of the sheets.
Implementation Steps
List all the steps involved during implementation.
Reviewed By
@spsither