learningequality / learningequality/studio
Fix incorrectly formatted KPUB ZIPs
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 191
- Forks
- 307
- Avg merge
- 5d 6h
- Merged PRs (30d)
- 10
Description
❌ This issue is not open for contribution. Visit Contributing guidelines to learn about the contributing process and how to find suitable issues.
Target branch: current production
Observed behavior
Same as for HTML5 ZIP files, when compressing the content for KPUB files, the underlying ZIP sometimes contains a folder that is creating errors for the content viewer.
Errors and logs
Observed while testing here: https://github.com/learningequality/kolibri/pull/15038#issuecomment-5139027696
Expected behavior
We should perform the same validation and format correction for KPUB uploads, as we did for HTML5.
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 reviewing the linked HTML5 issue 4013 and pull request 4867, then inspect the KPUB upload path and reproduce the malformed ZIP described in the Kolibri testing comment. Done means KPUB uploads receive the same validation and format correction as HTML5 ZIPs, without the extra folder that breaks the content viewer.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100