Skip to main content

Make zimfile from stackexchange dump

Project description

# Sotoki

Stack Overflow to Kiwix

The goal of this project is to create a suite of tools to create [zim]( files required by [kiwix]( reader to make available [Stack Overflow]( offline (without access to Internet).

[![PyPI](]( [![Docker Build Status](]( [![CodeFactor](]( [![License: GPL v3](](

## Getting started

The use of btrfs as a file system is recommended (and required for stackoverflow)

Install non python dependencies: `bash sudo apt-get install jpegoptim pngquant gifsicle advancecomp python-pip python-virtualenv python-dev libxml2-dev libxslt1-dev libbz2-dev p7zip-full python-pillow gif2apng imagemagick `

Create a virtual environment for python: `bash virtualenv --system-site-packages -p python3 ./ `

Activate the virtual enviroment: `bash source ./bin/activate `

Install this lib: `bash pip3 install sotoki `

Usage: `bash sotoki <domain> <publisher> [--directory=<dir>] [--nozim] [--tag-depth=<tag_depth>] [--threads=<threads>] [--zimpath=<zimpath>] [--reset] [--reset-images] [--clean-previous] [--nofulltextindex] [--ignoreoldsite] [--nopic] [--no-userprofile] `

You can use sotoki -h to have more explanation about these options

## Example

`bash for S in `./` ; do sotoki $S Kiwix --threads=12 --reset --clean-previous --no-userprofile ; done `

## License

[GPLv3]( or later, see [LICENSE](LICENSE) for more details.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sotoki, version 1.3.1
Filename, size File type Python version Upload date Hashes
Filename, size sotoki-1.3.1-py3-none-any.whl (2.1 MB) File type Wheel Python version py3 Upload date Hashes View
Filename, size sotoki-1.3.1.tar.gz (1.6 MB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page