openzim / openzim/zimwright

make `download_from` in offliner definition to be of type `url`

Open Beginner friendly
#2 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

Scraper argument download-from in offliner-definition.json file should be of type url instead of string. This helps zimfarm validate inputs more strictly and help prevent recipe creation if inputs are invalid.

Should we also make the flag required?

Contributor guide

No contributing guide indexed for this repository

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 with offliner-definition.json and inspect the scraper argument definition for download-from. Change its type from string to url, then verify the definition expresses the intended validation behavior; clarify with the maintainer whether the flag should also be required before considering the issue done.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Feature
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.