openzim / openzim/python-scraperlib

Add utility to index ePub documents content

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

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
31
Forks
27
Avg merge
3d 7h
Merged PRs (30d)
2

Description

Content of ePub documents is not indexed for full text search, while on some ZIM it is the "core" of the ZIM.

Extracting ePub info would be beneficial to multiple scrapers and should thus ideally be exposed in scraperlib, just like we did for PDFs in https://github.com/openzim/python-scraperlib/pull/182

See https://github.com/openzim/gutenberg/issues/95

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 reviewing the PDF extraction work in python-scraperlib pull request 182 and the related Gutenberg issue 95. Identify the reusable scraperlib entry point needed for ePub extraction and define completion as exposing ePub content and metadata so scrapers can use it for full-text indexing.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.