Skip to main content

OpenZIM export command for ka-lite

Project description

=============================
ka-lite-zim
=============================

.. image:: https://travis-ci.org/benjaoming/ka-lite-zim.png?branch=master
:target: https://travis-ci.org/benjaoming/ka-lite-zim

.. image:: https://readthedocs.org/projects/ka-lite-zim/badge/?version=latest
:target: http://ka-lite-zim.readthedocs.org/en/latest/


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, so we use prehistoric pip in virtualenv. Or you can also use our docker openzim/kalite.

::

virtualenv -p /usr/bin/python2.7 kalite-env
source kalite-env/bin/activate

mkdir -p ~/.kalite
echo "from kalite.project.settings.base import *" >> ~/.kalite/settings.py
echo "INSTALLED_APPS += ['kalite_zim', 'compressor',]\n" >> ~/.kalite/settings.py
pip install django>=1.5
pip install pip==7.0.0
pip install setuptools==12.0
pip install ka-lite==0.15
pip install ka-lite-zim

Export script is launched via ``kalite manage export2zim``.

**Don't forget ``--download`` options if you haven't video in your ``~/.kalite`` cache**

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

`List of languages <https://ka-lite.readthedocs.io/en/latest/faq.html#how-can-i-install-a-language-pack-without-a-reliable-internet-connection>`_


Features
--------

* Exporting the contents of a local `KA Lite <https://learningequality.org/ka-lite/>`_ installation to the `OpenZim <http://www.openzim.org/>`_
* 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 <http://www.kiwix.org/wiki/Content_in_all_languages>`_

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.


Future
------

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.




Documentation
-------------

The full documentation is at http://ka-lite-zim.rtfd.org.



History
-------

0.1.0 (2016-01-04)
++++++++++++++++++

* First release on PyPI.


Project details


Release history Release notifications

This version
History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
ka_lite_zim-0.1.2-py2.py3-none-any.whl (520.1 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jun 26, 2018
ka-lite-zim-0.1.2.tar.gz (481.5 kB) Copy SHA256 hash SHA256 Source None Jun 26, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page