zimscan 0.2.0

ZIM file iterator

ZIM Scan

Minimal ZIM file reader, designed for article streaming.

Getting Started

Install using pip:

pip install zimscan

Or from Git repository, for latest version:

pip install -U git+https://github.com/jojolebarjos/zimscan.git

Iterate over a records, which are binary file-like objects:

from zimscan import Reader

path = "wikipedia_en_all_nopic_2019-10.zim"
with Reader(open(path, "rb"), skip_metadata=True) as reader:
    for record in reader:
        data = record.read()
        ...

Links

• ZIM file format, official documentation
• Kiwix ZIM repository, to download official ZIM files
• Wikipedia ZIM dumps, to download Wikipedia ZIM files
• ZIMply, a ZIM file reader in the browser, in Python
• libzim, the reference implementation, in C++
• pyzim, Python wrapper for libzim
• pyzim, another Python wrapper for libzim
• Internet In A Box, a project to bundle open knowledge locally