/sotoki

StackOverflow to Kiwix: Script to create a Zim of StackExchange websites
  1. JavaScript 54.6%
  2. Python 26.4%
  3. HTML 13.5%
  4. CSS 3.1%
  5. Shell 1.8%
  6. Dockerfile 0.6%
Switch branches/tags
Nothing to show
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching Xcode...

If nothing happens, download Xcode and try again.

Launching Visual Studio...

If nothing happens, download the GitHub extension for Visual Studio and try again.

Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Add template issue Jan 15, 2018
sotoki Make release of 0.9.1 version Aug 4, 2018
.gitignore Add 'venv' to .gitignore Jul 3, 2016
Dockerfile Update Dockerfile Jun 13, 2018
LICENSE good licence and not html from github -_-' Apr 7, 2017
MANIFEST.in Add manifest in include non-python dependencies Apr 4, 2017
README.md Update readme Jun 12, 2018
list_all.sh Fix duplicates in list_all.sh May 29, 2017
make_release.instruction Make release of 0.8.4 Mar 17, 2018
setup.py Make release of 0.9.1 version Aug 4, 2018

README.md

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).

Getting started

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

Install non python dependencies:

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:

virtualenv --system-site-packages venv

Activate the virtual enviroment:

source venv/bin/activate

Install this lib:

pip install sotoki

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