Skip to main content

OpenZIM export command for ka-lite

Project description

OpenZIM export command for ka-lite.

Quick Start

Current code base is tied to version 0.15.1 of KA-Lite which fails to install from non-prehistoric pip.

virtualenv -p /usr/bin/python2.7 kalite-env
source kalite-env/bin/activate
git clone
cd ka-lite/
sed -i "" "s/os.path.join(where_am_i, '')/''/"
make install
cd ..
mkdir -p ~/.kalite
echo "from kalite.project.settings.base import *\n\nINSTALLED_APPS += ['kalite_zim', 'compressor',]\n" >> ~/.kalite/
git clone
cd kalite
pip install -e .

Export script is launched via kalite manage export2zim

Usage is available at kalite manage help export2zim

Beware! Despite what usage/help says, the proper parameter order is zim_file first then options. Example: kalite manage export2zim ka-fr.zim --language=fr

Note: if using the Docker zimwriterfs, make sure to work off the same absolute path of your docker volume (/data for example) for symlinks can be resolved.

ln -s /data/ /home/user/kalite
kalite manage export2zim /data/ka-fr.zim --language=fr --tmp-dir=/data/ka-lite-zim_fr
docker run --name zimwriterfs -v /data:/data openzim/zimwriterfs zimwriterfs XXX


  • Exporting the contents of a local KA Lite installation to the OpenZim
  • Easy to customize since you use KA Lite to select and download videos
  • Creates a .zim file with a single-page webapp containing video player and simple JS-based UI for filtering and searching the videos

Use case and contributions

This project is a Python project but is NOT on PyPi because it’s not intended for a wider audience. So just get the latest master, it should work with the latest KA Lite release. Please contribute to this project if you have changes to the .zim files that are available on the Kiwix website

The goal of this command is to build an alternative use case of Khan Academy for the popular offline reader Kiwix, which works for the open standards format OpenZim. Thus, it can benefit from the data prepared through the KA Lite software.

While KA Lite is truly built for education, Kiwix is more of an eLibrary. While Kiwix and OpenZim is more static, KA Lite has its focus on interaction.


The export command for KA Lite is the immediate and easiest target. But we hope to be able to understand the OpenZIM format well enough to build an import command as well such that KA Lite students can interact with the data packaged and distributed by zim-packagers.


The full documentation is at


0.1.0 (2016-01-04)

  • First release on PyPI.

Project details

Download files

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

Files for ka-lite-zim, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size ka_lite_zim-0.1.0-py2.py3-none-any.whl (17.4 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size ka-lite-zim-0.1.0.tar.gz (18.0 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page