3.1.0

Added

• Report scraper progress in a JSON file specified with --stats-filename (#228)

Fixed

• Fix main playlist selection to respect the order of provided playlist IDs (#286)
• Fix PLAYLISTS tab not being highlighted when the page is reloaded (#299)

Changed

• Update dependencies, including zimscraperlib 4 (#306)
• Update zimui title dynamically with the selected playlist/video title (#298)

3.0.1

Fixed

• Disable preloading of subtitles in video.js in zimui (#38)
• Fix scraper to exit properly when Too much videos failed to download exceptions are raised (#285)
• Clean up temporary files properly in case of exceptions during scraper run (#288)
• Implement infinite scroll for video/playlist lists and add loading spinners in zimui (#284)
• Update video.JS to 8.17.3, brings support for Chrome 58 and 59 (#275)

3.0.0

Changed

This release represent a very significant update of the scraper UI and the underlying technology (use Vue.JS 3 JS framework).

• Move scraper files to scraper subfolder and update workflows
• Bump requests package from 2.32.0 to 2.32.2
• Initialize new Vue.js project in zimui subfolder
• Update dependencies in pyproject.toml (pydantic, pyhumps, python-slugify)
• Update scraper to generate JSON files for zimui (#212)
• Remove old UI files and methods: template files (home.html, article.html) and make_html_files method in scraper.py
• Remove --locale arg, broken locale folder, files used for translation; translation will be restored with #222
• Create "Videos" and "Playlists" tabs for homepage in new Vue.js UI (#213, #214)
• Create video player page in new Vue.js UI (#215)
• Add support for variable playback speed in video player (#174)
• Updgrade to zimscraperlib 3.4.0 (including new webm encoder presets to migrate to VP9 instead of VP8) (#204)
• Add playlist panel for playing videos in a playlist (#216)
• Remove --autoplay CLI argument and set autoplay to always be true (#233)
• Add playlist view page in new Vue.js UI (#223)
• Add support for ogv.js in video-js player (#230)
• Remove openzim.toml and install all dependencies using Yarn (#218)
• Validate if ZIM cannot be created at given output location (#204)
• Add videos, subtitles, thumbnails and channel branding to the ZIM "on the fly" (#209)
• Remove --no-zim, --keep CLI arguments
• Add support to index content from zimui JSON files in the ZIM using custom IndexData (#224)
• Add integration tests to check the content of the ZIM created by the scraper (#268)
• Add an overlay image for the channel banner (#279)

2.3.1

Changed

• Upgrade to zimscraperlib 3.4.0 (including new webm encoder presets to migrate to VP9 instead of VP8) (#204)
• Upgrade to kiwixstorage 0.9.0 (including fix for #139 and #238)

2.3.0

Added

• New long_description CLI argument to set the ZIM long description
• New disable_metadata_check CLI argument to disable the metadata checks which are automated since zimscraperlib 3.x

Changed

• Changed default publisher metadata to 'openZIM'
• Validate ZIM metadata (tags, title, description, long_description) as early as possible
• Migrate to zimscraperlib 3.3.2 (including new VideoLowWebm encoder preset version 2)
• Upgrade Python dependencies, including migration to Python 3.12

2.2.0

Changed

• Using zimscraperlib 2.0.0 (#171)
• Using python 3.10 + debian bookworm (dropped support for older Python versions) (#180)
• Adopt Python bootstrap conventions (including hatch) (#180)

Fixed

• Fixed local path media (profile, banner) not working (#178)
• Unset metadata_from in youtube2zim-playlists (#185)
• Do not move local banner and profile images, copy them instead (#179)

2.1.18

• Switched to yt-dlp instead of youtube_dl
• Added fallback for subtitle languages with IDs-like suffixes (#161)
• Removed a reference to ZIM namespace that would break if first video has subtitles
• Fixed expected returncodes on errors (#166)
• Using ogv.js 1.8.9, videojs 7.20.3 and latest videojs-ogvjs (master)
• Using zimscraperlib 1.8.0