search

hackforla / website

Hack for LA's website
https://www.hackforla.org
GNU General Public License v2.0
325 stars 778 forks source link

Create Label Report in Google Spreadsheet #5810

Open kimberlytanyh opened 1 year ago

kimberlytanyh commented 1 year ago

Dependency

Overview

We need to create a data set with newly added and deleted labels, so that we can add them to a dashboard.

Detail

In a recent meeting, we noticed that there were instances when volunteers would add their own labels or delete official labels from the website team repository (accidentally or without permission). We want to catch these early to prevent any resulting problems.

When this issue is completed, there will be a spreadsheet (as the source of truth) that will show labels that have not yet been reviewed and it will release the dependency on creating the dashboard for a report that product will use to fix labels.

Preparing to work on this issue

You will need to be added to the following resources:

Action Items

Part 1: Creating a new dataset with labels

Part 2: Using the API to compare data sets, each with labels

We'll now repurpose the API call above to be used to detect new labels added or labels deleted from the website repository in the future (your code, once perfected, is to be added to the .py script currently in use for the dashboard in the live-dashboard-automation repository)

Resources/Instructions

  1. Editable version of Python script that handles cleaning and sending of data to Resource 5.I's "Unreviewed Newly Added or Deleted Labels" sheet (tab) (for testing)

  2. Template for .env file to go with Resource 1 (You need to get your own GitHub token - See Resource 6 - and add it to a .env file along with other credentials to run Resource 1)(Note: You can directly add the credentials in Resource 1 but it would be inconvenient when you want to share your work later without revealing your confidential information)

  3. Using Google API to Send and Read Data to Google Sheets: Update Google Sheets Using A Service Account With Google Sheets API In Python, How to Analyze Data in Google Sheets With Python: A Step-By-Step Guide

  4. Repository controlling automation of script run to update Looker dashboard

  5. Google Drive folder: Dashboard to put any additional resources created

    1. GitHub Project Board Issues - Data Analysis spreadsheet

  6. Slides with instructions on how to create GitHub token (see Appendix)

  7. Looker dashboard being worked on

  8. Refer to issue #4921 for information on Looker dashboard involved

  9. How to use .env file: Just add the .env file to the same folder where your Jupyter Notebook is to use it.

github-actions[bot] commented 1 year ago

Hi @kimberlytanyh.

Please don't forget to add the proper labels to this issue. Currently, the labels for the following are missing: Complexity, Role, Feature

NOTE: Please ignore the adding proper labels comment if you do not have 'write' access to this directory.

To add a label, take a look at Github's documentation here.

Also, don't forget to remove the "missing labels" afterwards. To remove a label, the process is similar to adding a label, but you select a currently added label to remove it.

After the proper labels are added, the merge team will review the issue and add a "Ready for Prioritization" label once it is ready for prioritization.

Additional Resources:

ExperimentsInHonesty commented 1 year ago

@kimberlytanyh This information should either be available in a repository, or in 1password, or a combination of both.

Contact me (kimberly.tan.yh@gmail.com) for Jupyter Notebook with script and the key required to access the "GitHub Project Board Issues - Data Analysis" spreadsheet

ExperimentsInHonesty commented 1 year ago

I removed the dependency on this issue as it didn't seem relevant. We are trying to finish 4921 not add more to it.

This report is to be added to the Looker dashboard in issue #4921

ExperimentsInHonesty commented 1 year ago

We will discuss with Sophia the best way to make Jupiter Notebook available without revealing secrets.

kimberlytanyh commented 1 year ago

Hello @ExperimentsInHonesty, I just took a look at the issue again and made some edits. Both editable Jupyter notebooks and .env files have been added to the live-dashboard-automation repository and changes have been made accordingly to this issue. My contact information has been removed.

ExperimentsInHonesty commented 6 months ago
Samhitha444 commented 1 month ago