# Kolibri Zim plugin
This is a Kolibri plugin to add a Zim file viewer.
## Usage
Install a release from pypi:
pip install kolibri-zim-plugin[full]
If you are using Kolibri 0.14.7, upgrade its bundled le-utils to the newest (unstable) version:
pip install git+https://github.com/learningequality/le-utils.git@master --target=$(python3 -c 'import sysconfig; print(sysconfig.get_paths()["purelib"])')/kolibri/dist --upgrade
Enable the plugin in Kolibri:
kolibri plugin enable kolibri_zim_plugin
Now, Zim content in Kolibri will be rendered using the Zim plugin.
For some example content, try adding the Wikipedia channel, either from Kolibri's user interface (you can use the channel token `nurob-nikis`) or with a management command:
kolibri manage importchannel network f62db29be20453c4a267132e93a9e602
kolibri manage importcontent network f62db29be20453c4a267132e93a9e602
## Development
### Getting started
Create a pipenv shell and then install additional dependencies using `bootstrap.sh`:
pipenv shell
./scripts/bootstrap.sh
Install kolibri-zim-plugin in editable mode:
pip install -e .
To build front end code:
yarn build
Refer to the [Usage instructions](#Usage) to upgrade le-utils and enable the plugin.
### Submitting changes
Before submitting changes, please be sure to run the pre-commit checks:
pre-commit run
If you can configure git to run these checks automatically:
pre-commit install -f --install-hooks
## Creating a release
If you are releasing a new version, use `bump-version` with with `major`, `minor`, or `patch`. For example:
yarn bump-version patch
This creates a new commit and a git tag. Push this to the remote:
git push
git push --tags
Create a `.whl` file:
yarn dist
The file will be placed in the `dist/` directory.
Finally, upload the `.whl` file to PyPi:
yarn release
Raw data
{
"_id": null,
"home_page": "https://github.com/endlessm/kolibri-zim-plugin",
"name": "kolibri-zim-plugin",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "kolibri",
"author": "Endless OS Foundation",
"author_email": "dylan@endlessos.org",
"download_url": "",
"platform": null,
"description": "# Kolibri Zim plugin\n\nThis is a Kolibri plugin to add a Zim file viewer.\n\n\n\n## Usage\n\nInstall a release from pypi:\n\n pip install kolibri-zim-plugin[full]\n\nIf you are using Kolibri 0.14.7, upgrade its bundled le-utils to the newest (unstable) version:\n\n pip install git+https://github.com/learningequality/le-utils.git@master --target=$(python3 -c 'import sysconfig; print(sysconfig.get_paths()[\"purelib\"])')/kolibri/dist --upgrade\n\nEnable the plugin in Kolibri:\n\n kolibri plugin enable kolibri_zim_plugin\n\nNow, Zim content in Kolibri will be rendered using the Zim plugin.\n\nFor some example content, try adding the Wikipedia channel, either from Kolibri's user interface (you can use the channel token `nurob-nikis`) or with a management command:\n\n kolibri manage importchannel network f62db29be20453c4a267132e93a9e602\n kolibri manage importcontent network f62db29be20453c4a267132e93a9e602\n\n## Development\n\n### Getting started\n\nCreate a pipenv shell and then install additional dependencies using `bootstrap.sh`:\n\n pipenv shell\n ./scripts/bootstrap.sh\n\nInstall kolibri-zim-plugin in editable mode:\n\n pip install -e .\n\nTo build front end code:\n\n yarn build\n\nRefer to the [Usage instructions](#Usage) to upgrade le-utils and enable the plugin.\n\n### Submitting changes\n\nBefore submitting changes, please be sure to run the pre-commit checks:\n\n pre-commit run\n\nIf you can configure git to run these checks automatically:\n\n pre-commit install -f --install-hooks\n\n## Creating a release\n\nIf you are releasing a new version, use `bump-version` with with `major`, `minor`, or `patch`. For example:\n\n yarn bump-version patch\n\nThis creates a new commit and a git tag. Push this to the remote:\n\n git push\n git push --tags\n\nCreate a `.whl` file:\n\n yarn dist\n\nThe file will be placed in the `dist/` directory.\n\nFinally, upload the `.whl` file to PyPi:\n\n yarn release\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Kolibri plugin to add a Zim file viewer",
"version": "1.4.2",
"project_urls": {
"Homepage": "https://github.com/endlessm/kolibri-zim-plugin"
},
"split_keywords": [
"kolibri"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "131208c5e68cd3dacab7393e38b66a995c1795a679f5a8c87611d3d911ca3021",
"md5": "4f64288ad95756fdaac9447ee5cec828",
"sha256": "659d3e5002a9aa9e2f4b9a7d2f548e61191d340d7ff6588f6ff06eeccfe76449"
},
"downloads": -1,
"filename": "kolibri_zim_plugin-1.4.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "4f64288ad95756fdaac9447ee5cec828",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 182376,
"upload_time": "2023-06-12T22:14:09",
"upload_time_iso_8601": "2023-06-12T22:14:09.336419Z",
"url": "https://files.pythonhosted.org/packages/13/12/08c5e68cd3dacab7393e38b66a995c1795a679f5a8c87611d3d911ca3021/kolibri_zim_plugin-1.4.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-12 22:14:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "endlessm",
"github_project": "kolibri-zim-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kolibri-zim-plugin"
}
JSON
