hackerkid/Mind-Expanding-Books

Make sure that the book reviews data are upto date

Open

#235 opened on Oct 10, 2020

View on GitHub
 (3 comments) (0 reactions) (1 assignee)JavaScript (1,095 forks)batch import
hacktoberfestpythonwebsite

Repository metrics

Stars
 (10,904 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

We show the Goodreads star count in the website. We fetch the data using the following script

Mind-Expanding-Books/utils/update_json_files.py

The script generates two json files which are then copied to app/src/data directory.

At the moment I run this script manually. But it would be cool to automate the step using GitHub actions.

The tricky thing is to make sure that you don't call the Google API(used in the script for fetching Amazon link) unnecessarily since it has a very low rate limit.

The action should only fetch the necessary data required and reuse existing data as much as it's possible.

Contributor guide

Research direction
Create a GitHub Actions workflow that triggers on schedule or manual dispatch. The workflow should run update json files.py, but only update data if Goodreads ratings have changed. Use caching to avoid unnecessary API calls to Google API. Study the existing script to understand data dependencies and implement conditional execution.
Tech stack
pythonjavascript
Domain
backenddevops
Issue type
Feature
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-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
PythonGitHub Actions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50