simonw / simonw/shot-scraper

Validate YAML mini-language using Pydantic

Open
#28 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
2.6k
Forks
128
Avg merge
9d 15h
Merged PRs (30d)
2

Description

Since PDF will accept a different set of options from regular screenshots I think this will be the point at which I add much more robust validation of the YAML mini-language, probably using https://pydantic-docs.helpmanual.io/

Originally posted by @simonw in https://github.com/simonw/shot-scraper/issues/27#issuecomment-1065949072

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the YAML mini-language handling in shot-scraper and review the Pydantic documentation linked in the issue. Define how validation should distinguish regular screenshot options from PDF options, then verify that invalid YAML is rejected and supported options are accepted.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.