# Kolibri Dynamic Collections plugin
This is a Kolibri plugin for dynamic collections, which are a new way to
bundle together content across multiple Kolibri channels. The plugin includes
database models and utilities to manage dynamic collections, as well as an
editor to create collections from a selection of channels and content nodes.
## Usage
Install a release from pypi:
pip install kolibri-dynamic-collections-plugin
Enable the plugin in Kolibri:
kolibri plugin enable kolibri_dynamic_collections_plugin
## Development
### Getting started
Create a pipenv shell and then install additional dependencies using `bootstrap.sh`:
pipenv shell
./scripts/bootstrap.sh
Install kolibri-dynamic-collections-plugin in editable mode:
pip install -e .
To build front end code:
yarn build
Refer to the [Usage instructions](#Usage) to 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-dynamic-collections-plugin",
"name": "kolibri-dynamic-collections-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 Dynamic Collections plugin\n\nThis is a Kolibri plugin for dynamic collections, which are a new way to\nbundle together content across multiple Kolibri channels. The plugin includes\ndatabase models and utilities to manage dynamic collections, as well as an\neditor to create collections from a selection of channels and content nodes.\n\n## Usage\n\nInstall a release from pypi:\n\n pip install kolibri-dynamic-collections-plugin\n\nEnable the plugin in Kolibri:\n\n kolibri plugin enable kolibri_dynamic_collections_plugin\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-dynamic-collections-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 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.5.1",
"project_urls": {
"Homepage": "https://github.com/endlessm/kolibri-dynamic-collections-plugin"
},
"split_keywords": [
"kolibri"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2bcee0be3e81a61fa4efffad02062c7d49a86e79365ab3ddd3874f2137ddbabb",
"md5": "d0b957c811d1507e54b095bac0c5dc13",
"sha256": "f5eb9ba95ea3f7fd958ac8dc51196a26416881e346d0a5ea0c752a6b08204b50"
},
"downloads": -1,
"filename": "kolibri_dynamic_collections_plugin-1.5.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "d0b957c811d1507e54b095bac0c5dc13",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 708774,
"upload_time": "2023-06-05T18:38:09",
"upload_time_iso_8601": "2023-06-05T18:38:09.993187Z",
"url": "https://files.pythonhosted.org/packages/2b/ce/e0be3e81a61fa4efffad02062c7d49a86e79365ab3ddd3874f2137ddbabb/kolibri_dynamic_collections_plugin-1.5.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-05 18:38:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "endlessm",
"github_project": "kolibri-dynamic-collections-plugin",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kolibri-dynamic-collections-plugin"
}
JSON
