| Name | kolibri2zim JSON |
| Version |
1.2.1
JSON |
| download |
| home_page | |
| Summary | Make ZIM file from Kolibri Channels |
| upload_time | 2024-02-29 13:14:12 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | <3.13,>=3.12 |
| license | GPL-3.0-or-later |
| keywords |
kolibri
offline
openzim
zim
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
kolibri2zim
=============
[](https://www.codefactor.io/repository/github/openzim/kolibri)
[](https://ghcr.io/openzim/kolibri)
[](https://www.gnu.org/licenses/gpl-3.0)
[](https://pypi.org/project/kolibri2zim/)
`kolibr2zim` allows you to create a [ZIM file](https://openzim.org) 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
------------
* [`ffmpeg`](https://ffmpeg.org/) for video transcoding (only used with `--use-webm` or `--low-quality`).
* `curl` and `unzip` to install Javascript dependencies. See `get_js_deps.sh` if you want to do it manually.
Installation
------------
## Virtualenv
`kolibri2zim` is a Python3 software. If you are not using the
[Docker](https://docker.com) image, you are advised to use it in a
virtual environment to avoid installing software dependencies on your system.
```bash
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
```bash
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](https://studio.learningequality.org) or the [Kolibri Catalog](https://kolibri-catalog-en.learningequality.org)
Development
-----------
kolibri2zim adheres to openZIM's [Contribution Guidelines](https://github.com/openzim/overview/wiki/Contributing).
kolibri2zim has implemented openZIM's [Python bootstrap, conventions and policies](https://github.com/openzim/_python-bootstrap/docs/Policy.md) **v1.0.0**.
Before contributing be sure to check out the
[CONTRIBUTING.md](CONTRIBUTING.md) guidelines.
To test epubs and pdfs rendering, a potential usefull command is:
```bash
kolibri2zim --name "Biblioteca Elejandria" --output /output --tmp-dir /tmp --zim-file Biblioteca_Elejandria.zim --channel-id "fed29d60e4d84a1e8dcfc781d920b40e" --node-ids 'd92c07655128458f8248416154b18a68,89fe2f86ee3f4fbaa7fb2bf9bd56d088,75f99e6b97d14b14a4e74762ad77391f,89fe2f86ee3f4fbaa7fb2bf9bd56d088'
```
License
-------
[GPLv3](https://www.gnu.org/licenses/gpl-3.0) or later, see
[LICENSE](LICENSE) for more details.
Raw data
{
"_id": null,
"home_page": "",
"name": "kolibri2zim",
"maintainer": "",
"docs_url": null,
"requires_python": "<3.13,>=3.12",
"maintainer_email": "",
"keywords": "kolibri,offline,openzim,zim",
"author": "",
"author_email": "openZIM <dev@openzim.org>",
"download_url": "https://files.pythonhosted.org/packages/4b/df/fc3f02e0058da0a7b511e99be8d6182ea9440124434f90d40b6d04557175/kolibri2zim-1.2.1.tar.gz",
"platform": null,
"description": "kolibri2zim\n=============\n\n[](https://www.codefactor.io/repository/github/openzim/kolibri)\n[](https://ghcr.io/openzim/kolibri)\n[](https://www.gnu.org/licenses/gpl-3.0)\n[](https://pypi.org/project/kolibri2zim/)\n\n`kolibr2zim` allows you to create a [ZIM file](https://openzim.org) from a Kolibri Channel.\n\nIt downloads the video (`webm` or `mp4` extension \u2013 optionnaly\nrecompress them in lower-quality, smaller size), the thumbnails, the\nsubtitles and the authors' profile pictures ; then, it create a static\nHTML files folder of it before creating a ZIM off of it.\n\nRequirements\n------------\n\n* [`ffmpeg`](https://ffmpeg.org/) for video transcoding (only used with `--use-webm` or `--low-quality`).\n* `curl` and `unzip` to install Javascript dependencies. See `get_js_deps.sh` if you want to do it manually.\n\nInstallation\n------------\n\n## Virtualenv\n\n`kolibri2zim` is a Python3 software. If you are not using the\n[Docker](https://docker.com) image, you are advised to use it in a\nvirtual environment to avoid installing software dependencies on your system.\n\n```bash\npython3 -m venv env # Create virtualenv\nsource env/bin/Activate # Activate the virtualenv\npip3 install kolibri2zim # Install dependencies\nkolibri2zim --help # Display kolibri2zim help\n```\n\nCall `deactivate` to quit the virtual environment.\n\nSee `requirements.txt` for the list of python dependencies.\n\n## Docker\n\n```bash\ndocker run -v my_dir:/output ghcr.io/openzim/kolibri2zim kolibri2zim --help\n```\n\nUsage\n-----\n\n`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](https://studio.learningequality.org) or the [Kolibri Catalog](https://kolibri-catalog-en.learningequality.org)\n\nDevelopment\n-----------\n\nkolibri2zim adheres to openZIM's [Contribution Guidelines](https://github.com/openzim/overview/wiki/Contributing).\n\nkolibri2zim has implemented openZIM's [Python bootstrap, conventions and policies](https://github.com/openzim/_python-bootstrap/docs/Policy.md) **v1.0.0**.\n\nBefore contributing be sure to check out the\n[CONTRIBUTING.md](CONTRIBUTING.md) guidelines.\n\nTo test epubs and pdfs rendering, a potential usefull command is:\n```bash\nkolibri2zim --name \"Biblioteca Elejandria\" --output /output --tmp-dir /tmp --zim-file Biblioteca_Elejandria.zim --channel-id \"fed29d60e4d84a1e8dcfc781d920b40e\" --node-ids 'd92c07655128458f8248416154b18a68,89fe2f86ee3f4fbaa7fb2bf9bd56d088,75f99e6b97d14b14a4e74762ad77391f,89fe2f86ee3f4fbaa7fb2bf9bd56d088'\n```\n\nLicense\n-------\n\n[GPLv3](https://www.gnu.org/licenses/gpl-3.0) or later, see\n[LICENSE](LICENSE) for more details.\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Make ZIM file from Kolibri Channels",
"version": "1.2.1",
"project_urls": {
"Donate": "https://www.kiwix.org/en/support-us/",
"Homepage": "https://github.com/openzim/kolibri"
},
"split_keywords": [
"kolibri",
"offline",
"openzim",
"zim"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "62be08dfac3ebfb174bf2c52cbfdf7017ef7a26dbc37229208bf5504090f8eaf",
"md5": "08aedc0647991946a996f866eea78671",
"sha256": "e4340aa3db915fc4190f7a327ce435767183a82d4e2a581e49f20e9880492adf"
},
"downloads": -1,
"filename": "kolibri2zim-1.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "08aedc0647991946a996f866eea78671",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.12",
"size": 143761,
"upload_time": "2024-02-29T13:14:10",
"upload_time_iso_8601": "2024-02-29T13:14:10.807462Z",
"url": "https://files.pythonhosted.org/packages/62/be/08dfac3ebfb174bf2c52cbfdf7017ef7a26dbc37229208bf5504090f8eaf/kolibri2zim-1.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4bdffc3f02e0058da0a7b511e99be8d6182ea9440124434f90d40b6d04557175",
"md5": "0e63762eccf15ae1ae18c74176dc7a2b",
"sha256": "6e5b3db5fa6b75d4bd5c8313ff4f980ee7c687ffeed45b7f444caa7a8478308b"
},
"downloads": -1,
"filename": "kolibri2zim-1.2.1.tar.gz",
"has_sig": false,
"md5_digest": "0e63762eccf15ae1ae18c74176dc7a2b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.12",
"size": 151863,
"upload_time": "2024-02-29T13:14:12",
"upload_time_iso_8601": "2024-02-29T13:14:12.198499Z",
"url": "https://files.pythonhosted.org/packages/4b/df/fc3f02e0058da0a7b511e99be8d6182ea9440124434f90d40b6d04557175/kolibri2zim-1.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-29 13:14:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openzim",
"github_project": "kolibri",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kolibri2zim"
}
