zimscraperlib

Collection of python code to re-use across python-based scrapers

Usage

• This library is meant to be installed via PyPI (zimscraperlib).
• Make sure to reference it using a version code as the API is subject to frequent changes.
• API should remain the same only within the same minor version.

Example usage:

zimscraperlib>=1.1,<1.2

Dependencies

• libmagic
• wget
• libzim (auto-installed, not available on Windows)
• Pillow
• FFmpeg
• gifsicle (>=1.92)

macOS

brew install libmagic wget libtiff libjpeg webp little-cms2 ffmpeg gifsicle

Linux

sudo apt install libmagic1 wget ffmpeg \
    libtiff5-dev libjpeg8-dev libopenjp2-7-dev zlib1g-dev \
    libfreetype6-dev liblcms2-dev libwebp-dev tcl8.6-dev tk8.6-dev python3-tk \
    libharfbuzz-dev libfribidi-dev libxcb1-dev gifsicle

Contribution

pip -r requirements.txt
pip install tox pre-commit
pre-commit install
# For tests
tox

Users

Non-exhaustive list of scrapers using it (check status when updating API):

• openzim/youtube
• openzim/nautilus

releasing

• Update your dependencies: pip install -U setuptools wheel twine
• Make sure CHANGELOG.md is up-to-date
• Bump version on src/zimscraperlib/VERSION
• Build packages python ./setup.py sdist bdist_wheel
• Upload to PyPI twine upload dist/zimscraperlib-2.0.0*.
• Commit your Changelog + version bump changes
• Tag version on git git tag -a v2.0.0