DenverCoder1/github-readme-youtube-cards

馃殌 Feature: JSON output option

Open

#25 opened on Sep 11, 2022

View on GitHubContributor guide
聽(17 comments)聽(0 reactions)聽(0 assignees)Python聽(60 forks)github user discovery
featuregood first issueup-for-grabs

Repository metrics

Stars
聽(274 stars)
PR merge metrics
聽(Avg merge 53d 1h)聽(3 merged PRs in 30d)

Description

The user may want to parse the output manually in a different action step.

An option, for example, output_type: "json" could be useful to allow such customization more easily.

A format such as the following may be useful (all the params, plus the svg card url)

[
  {
      "id": "...",
      "title": "...",
      "timestamp": "...",
      "background_color": "...",
      "title_color": "...",
      "stats_color": "...",
      "width": "...",
      "duration": "...", // if applicable
      "image_url": "https://ytcards.demolab.com/?id=...&...",
  },
  {
      ...
  },
]

This can be coordinated with #24 since both involve adding output_type.

Contributor guide

Research direction
Implement a new 'output type' option that, when set to 'json', returns the video data as JSON instead of SVG cards. Ensure the JSON includes all fields: id, title, timestamp, background color, title color, stats color, width, duration, image url. Coordinate with issue #24 if needed.
Tech stack
python
Domain
tooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70