openzim / openzim/cms

Allow to ingest ZIM popularity

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

Nobody has claimed this yet.

enhancement question
Dominant language
Python
Stars
7
Forks
1
Avg merge
15h 20m
Merged PRs (30d)
18

Description

We want to be able to weight the result of a library search based on there popularity. The popularity is defined by the number of downloads (proportionally to the other ZIMs).

That means that we need:

  • To ingest the number of downloads of all ZIM base on https://stats.kiwix.org
  • Compute a popularity rate for each ZIM file over time (doing this time to time)
  • Apply the popularity to each ZIM file in the DB
  • Export the popularity in the XML (or ultimately in the OPDS).

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 by tracing the existing search, ZIM ingestion, database, and XML export entry points, then review the download data available at https://stats.kiwix.org. The work is complete when popularity rates can be periodically computed from downloads, applied to each ZIM in the database, and exported in XML or OPDS.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
backend, data, database
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.