kolibri2zim
kolibr2zim allows you to create a ZIM file from a Kolibri Channel.
It downloads the video (webm or mp4 extension – optionnaly
recompress them in lower-quality, smaller size), the thumbnails, the
subtitles and the authors' profile pictures ; then, it create a static
HTML files folder of it before creating a ZIM off of it.
Requirements
ffmpegfor video transcoding (only used with--use-webmor--low-quality).curlandunzipto install Javascript dependencies. Seeget_js_deps.shif you want to do it manually.
Installation
Virtualenv
kolibri2zim 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 # Create virtualenv
source env/bin/Activate # Activate the virtualenv
pip3 install kolibri2zim # Install dependencies
kolibri2zim --help # Display kolibri2zim help
Call deactivate to quit the virtual environment.
See requirements.txt for the list of python dependencies.
Docker
docker run -v my_dir:/output ghcr.io/openzim/kolibri2zim kolibri2zim --help
Usage
kolibri2zim works off a channel-id that you must provide. This is a 32-characters long ID that you can find in the URL of the channel you want, either from Kolibri Studio or the Kolibri Catalog
Development
kolibri2zim adheres to openZIM's Contribution Guidelines.
kolibri2zim has implemented openZIM's Python bootstrap, conventions and policies v1.0.0.
Before contributing be sure to check out the CONTRIBUTING.md guidelines.
To test epubs and pdfs rendering, a potential usefull command is:
kolibri2zim --name "Biblioteca Elejandria" --output /output --tmp-dir /tmp --zim-file Biblioteca_Elejandria.zim --channel-id "fed29d60e4d84a1e8dcfc781d920b40e" --node-ids 'd92c07655128458f8248416154b18a68,89fe2f86ee3f4fbaa7fb2bf9bd56d088,75f99e6b97d14b14a4e74762ad77391f,89fe2f86ee3f4fbaa7fb2bf9bd56d088'
License
Metadata
Release files for kolibri2zim 1.2.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 | Provenance | Actions |
|---|---|---|---|---|
| kolibri2zim-1.2.1.tar.gz | 151.9 kB | Without provenance | Details for kolibri2zim-1.2.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| kolibri2zim-1.2.1-py3-none-any.whl | Python 3 | none | any | Details for kolibri2zim-1.2.1-py3-none-any.whl |
Total release size: 295.6 kB
Release files / kolibri2zim-1.2.1.tar.gz
| Download URL | kolibri2zim-1.2.1.tar.gz |
|---|---|
| Size | 151.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6e5b3db5fa6b75d4bd5c8313ff4f980ee7c687ffeed45b7f444caa7a8478308b
|
|
BLAKE2b-256 checksum How to use checksums |
4bdffc3f02e0058da0a7b511e99be8d6182ea9440124434f90d40b6d04557175
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/4.0.2 CPython/3.11.8
|
Release files / kolibri2zim-1.2.1-py3-none-any.whl
| Download URL | kolibri2zim-1.2.1-py3-none-any.whl |
|---|---|
| Size | 143.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
e4340aa3db915fc4190f7a327ce435767183a82d4e2a581e49f20e9880492adf
|
|
BLAKE2b-256 checksum How to use checksums |
62be08dfac3ebfb174bf2c52cbfdf7017ef7a26dbc37229208bf5504090f8eaf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/4.0.2 CPython/3.11.8
|
Security for kolibri2zim 1.2.1
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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.