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](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/sotoko) [![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 venv `

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

Install this lib: `bash pip 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


Download files

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

Source Distribution

sotoki-1.1.tar.gz (1.6 MB view details)

Uploaded Source

Built Distribution

sotoki-1.1-py2-none-any.whl (1.7 MB view details)

Uploaded Python 2

File details

Details for the file sotoki-1.1.tar.gz.

File metadata

  • Download URL: sotoki-1.1.tar.gz
  • Upload date:
  • Size: 1.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/2.7.11

File hashes

Hashes for sotoki-1.1.tar.gz
Algorithm Hash digest
SHA256 07f18ed3bd3b6ed5758da923870a701da358c66b20fcd98aa886df8ccee48c44
MD5 48572c052fef9d2bde58b65d845c8ac0
BLAKE2b-256 351c0b112130ff5f1001c0f619ff1ddb519e700322f45ea5b41f66fdf2fa3270

See more details on using hashes here.

File details

Details for the file sotoki-1.1-py2-none-any.whl.

File metadata

  • Download URL: sotoki-1.1-py2-none-any.whl
  • Upload date:
  • Size: 1.7 MB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.41.1 CPython/2.7.11

File hashes

Hashes for sotoki-1.1-py2-none-any.whl
Algorithm Hash digest
SHA256 a6b92e2e970ad80f17b5bd394f5d684cf2f5d36e25955664e1f22a0c446e18b1
MD5 d0afb06fc8c2ecf44484835e8e7a1b7c
BLAKE2b-256 c804133af75128b70172e7fdaf8768b5cba366e050ba74cb649b819c8eac2f04

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page