sotoki 2.0.0

Turn StackExchange dumps into ZIM files for offline usage

Sotoki

sotoki (stackoverflow to kiwix) is an OpenZIM scraper to create offline versions of Stack Exchange websites such as stack overflow.

It is based on Stack Exchange's Data Dumps hosted by The Internet Archive.

⚠️ Warning

sotoki is undergoing a major rewrite to use libzim7 and its python binding in order to bypass filesystem limitations seen in version 1.x. Use tagged version until this warning is removed as current master is not-functionnal.

Usage

sotoki works off a domain that you must provide. That is the domain-name of the stackexchange website you want to scrape. Run sotoki --list-all to get a list of those

Note: when running off the git repository, you'll need to download a few external dependencies that we pack in Python releases. Just run python src/sotoki/dependencies.py

Docker

docker run -v my_dir:/output openzim/sotoki sotoki --help

Virtualenv

sotoki is a Python3 software. If you are not using the Docker image, you are advised to use it in a virtual environment to avoid installing software dependencies on your system.

python3 -m venv env      # Create virtualenv
source env/bin/Activate  # Activate the virtualenv
pip3 install sotoki # Install dependencies
sotoki --help       # Display kolibri2zim help

Call deactivate to quit the virtual environment.

See requirements.txt for the list of python dependencies.