openzim / openzim/devdocs

Support progress tracking for Zimfarm

Open
#11 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
9
Forks
3
PR merge metrics
No merged PRs in 30d

Description

Implement a task progress JSON file so Zimfarm can report status.

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 the linked export.py example at line 293 to understand the task progress JSON format, then locate the corresponding export flow in this repository. Confirm how Zimfarm consumes the file and verify that a representative scrape produces the expected progress data.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
devops
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.