Expose the title popularity in the OPDS stream
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 7
- Forks
- 1
- Avg merge
- 15h 20m
- Merged PRs (30d)
- 18
Description
This depends on https://github.com/openzim/cms/issues/449 and This depends on https://github.com/openzim/cms/issues/301
Assuming the CMS know the popularity of each title, it will become necessary to share the popularity index via the OPDS stream.
This implies:
- Define the OPDS formalism, compatible with the OPDS spec
- Update the OPDS API to this new OPDS stream feature
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the dependent issues #449 and #301, then compare the current OPDS API with the OPDS specification. Define a compatible popularity representation and update the OPDS API to expose it; the work is done when the formalism and stream behavior are specified and implemented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100