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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sotoki-1.2.tar.gz
.
File metadata
- Download URL: sotoki-1.2.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
Algorithm | Hash digest | |
---|---|---|
SHA256 | 84402d8a773b74435694bb8c7fb3edfad6e219e4185d1d863e7a7b766e807962 |
|
MD5 | e50a908825ed0c4972ec004557cbd25b |
|
BLAKE2b-256 | 8ec0a004904b8cb3824a8e103671a1cd49b05f2db5124d7c0e6afa2d036dc83f |
File details
Details for the file sotoki-1.2-py3-none-any.whl
.
File metadata
- Download URL: sotoki-1.2-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
Algorithm | Hash digest | |
---|---|---|
SHA256 | b7a53deafbb651baf73355851a865ad6117bb8b74e2837be7c3001cf94303d04 |
|
MD5 | 126582a6da3b9f28535ce667efbc9cf2 |
|
BLAKE2b-256 | 63d5d31b529aa6606de53a503ad95ce791fefe80673f706e8d3fe23881377096 |