openzim / openzim/python-libzim
Multiple archive searcher
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 108
- Forks
- 29
- Avg merge
- 9d 1h
- Merged PRs (30d)
- 1
Description
As highlighted by #229, Searcher's getResults() only yields result's entry path. while convenient for single-archive search, it prevents implementing multi-ZIM search as results would only be path strings from multiple ZIMs.
We should then implement multiple ZIM search properly by
- Binding addArche to Searcher (ref impl in #229)
- Change Searcher API so that results can be identified
Contributor guide
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 reading Searcher.getResults() and the reference implementation in #229, then trace how archives are currently associated with a Searcher. Define the API changes needed for results to identify their source ZIM and verify that searches across multiple ZIM files can distinguish entries from each archive.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, search
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100