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/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


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.3.tar.gz (1.6 MB view details)

Uploaded Source

Built Distribution

sotoki-1.3-py3-none-any.whl (2.1 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sotoki-1.3.tar.gz
  • Upload date:
  • Size: 1.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.0

File hashes

Hashes for sotoki-1.3.tar.gz
Algorithm Hash digest
SHA256 3038e943caaabbf02fa560d5c66bc83dc8cea561091cfe7810675d5babfe398c
MD5 9b8543317732dab97af1fac5a22a955f
BLAKE2b-256 49b7b0c51540727951d6e896204976615693fcad191fb70c1f471d72aeed3fe2

See more details on using hashes here.

File details

Details for the file sotoki-1.3-py3-none-any.whl.

File metadata

  • Download URL: sotoki-1.3-py3-none-any.whl
  • Upload date:
  • Size: 2.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.0

File hashes

Hashes for sotoki-1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 58352292a0b96b845c47f9c46dedf714374b34feba9bed687f30a480659701f4
MD5 46b34c2e29599886552130160132a841
BLAKE2b-256 c41fedd101865ba435c6c7dff860d858914c214aa641a235979e836cf1bd29b3

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