Metadata-Version: 2.0
Name: sotoki
Version: 1.0
Summary: Make zimfile from stackexchange dump
Home-page: http://github.com/kiwix/sotoki
Author: dattaz
Author-email: taz@dattaz.fr
License: GPL
Keywords: kiwix zim stackexchange offline
Platform: Linux
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Requires-Dist: Jinja2 (==2.8)
Requires-Dist: lxml (==3.4.4)
Requires-Dist: MarkupSafe (==0.23)
Requires-Dist: docopt (==0.6.2)
Requires-Dist: slugify (==0.0.1)
Requires-Dist: pydenticon (==0.2)
Requires-Dist: bs4
Requires-Dist: envoy
Requires-Dist: subprocess32
Requires-Dist: filemagic
Requires-Dist: mistune

# Sotoki

*Stack Overflow to Kiwix*

The goal of this project is to create a suite of tools to create
[zim](http://www.openzim.org) files required by
[kiwix](http://kiwix.org/) reader to make available [Stack Overflow](https://stackoverflow.com/)
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


