Sotoki
Sotoki (Stack Overflow to Kiwix) is an
openZIM scraper to create offline
versions of Stack Exchange websites such
as Stack Overflow.
It is based on Stack Exchange's Data Dumps hosted by The Internet Archive.
Usage
Sotoki works off a dump of a StackExchange website, as regularly created by StackExchange team. You must provide
a --mirror to use to download this dump and the --domain you want to scrape.
For instance, to download Sports StackExchange website as of August 2024 and based on dump hosted on archive.org,
you have to use --mirror https://archive.org/download/stackexchange_20240829 --domain sports.stackexchange.com.
Value of mirror is hence continuously updated as new dumps are published by StackExchange team.
Other CLI parameters are mandatory:
--title: ZIM title, must be less than 30 chars. E.g.Gardening and Landscaping--description: ZIM description, must be less than 80 chars
Docker
docker run -v my_dir:/output ghcr.io/openzim/sotoki sotoki --help
Installation
sotoki is a Python3 software. If you are not using the
Docker image, you are advised to use it in a
virtual environment to avoid installing software dependencies on your
system.
python3 -m venv ./env # creates a virtual python environment in ./env folder
./env/bin/pip install -U pip # upgrade pip (package manager). recommended
./env/bin/pip install -U sotoki # install/upgrade sotoki inside virtualenv
# direct access to in-virtualenv sotoki binary, without shell-attachment
./env/bin/sotoki --help
# alias or link it for convenience
sudo ln -s $(pwd)/env/bin/sotoki /usr/local/bin/
# alternatively, attach virtualenv to shell
source env/bin/activate
sotoki --help
deactivate # unloads virtualenv from shell
Developers
Anybody is welcome to improve the Sotoki.
See CONTRIBUTING.md for setup instructions, code style guidelines, and changelog requirements.
Users
You don't have to make your own ZIM files of Stack Exchange's Web sites. Updated ZIM files are built on a regular basis for all of them. Look at https://library.kiwix.org/?category=stack_exchange to download them.
1 maintainer
Metadata
1 maintainer
Release files for sotoki 3.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sotoki-3.1.1.tar.gz | 94.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sotoki-3.1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 190.2 kB
Release files / sotoki-3.1.1.tar.gz
| Download URL | sotoki-3.1.1.tar.gz |
|---|---|
| Size | 94.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ff2b5383c11dbcf062be79c9c8b89034a7442691210684c776d60d0610a29b94
|
|
BLAKE2b-256 checksum How to use checksums |
0f9f668240304a65d9a13dfa04730fb6b7bc1736a4e2a630ad8c9ad4894a47d1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 2, 2026.
Transparency logRelease files / sotoki-3.1.1-py3-none-any.whl
| Download URL | sotoki-3.1.1-py3-none-any.whl |
|---|---|
| Size | 96.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8a6524ddd3fabd6be6e501dbf367e05c5aefc46abc9b24142e0eaf0917071cc1
|
|
BLAKE2b-256 checksum How to use checksums |
60e3c1854225bebacac1f224f45c9ed9fcd83f2fe86afa4e9ff6c3a897aa93e2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 2, 2026.
Transparency log
