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](https://openzim.org) files required by [kiwix](https://kiwix.org/) reader to make available [Stack Overflow](https://stackoverflow.com/) offline (without access to Internet).
[![PyPI](https://img.shields.io/pypi/v/sotoki.svg)](https://pypi.python.org/pypi/sotoki) [![Docker Build Status](https://img.shields.io/docker/build/openzim/sotoki)](https://hub.docker.com/r/openzim/sotoki) [![CodeFactor](https://www.codefactor.io/repository/github/openzim/sotoki/badge)](https://www.codefactor.io/repository/github/openzim/sotoki) [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
## 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 `./list_all.sh` ; do sotoki $S Kiwix --threads=12 --reset --clean-previous --no-userprofile ; done `
## License
[GPLv3](https://www.gnu.org/licenses/gpl-3.0) or later, see [LICENSE](LICENSE) for more details.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.