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

Uploaded Source

Built Distribution

sotoki-1.2.1-py3-none-any.whl (1.7 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sotoki-1.2.1.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.2.1.tar.gz
Algorithm Hash digest
SHA256 e15e929639344f2a43a21f49389e68e0df8099306eb12cab5e15c667c94760e7
MD5 089aaaec72225ad65923f712a65adf22
BLAKE2b-256 78dff307c3b98a4aea2150388eb429c9adae396d7d1b5bd5bfec13e3f1f644bc

See more details on using hashes here.

File details

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

File metadata

  • Download URL: sotoki-1.2.1-py3-none-any.whl
  • Upload date:
  • Size: 1.7 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.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 83994e155c94a27578adb4b11802175f3b3d5311d818be38e829379a2796c464
MD5 7747d786591229531fb73b6640f8807d
BLAKE2b-256 ec9a4f013a578086ea07bc85246786b01c2559273cbd8125a6f791a997a52595

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