This plugin adds the Endless Key experience on top of Kolibri:
A content navigation view exposed in the /explore
URL. As an
alternative to the Kolibri Learn plugin for self-guided learners.
Branding and layout customizations for several channels.
Download of content packs with extra metadata.
This is a plugin for Kolibri, so it must be installed in your Kolibri environment.
Install latest release from PyPi:
pip install kolibri-explore-plugin
Then enable it in Kolibri and run migrations:
kolibri plugin enable kolibri_explore_plugin
kolibri manage migrate
Download the apps-bundle.zip
from the GitHub releases
page and
extract them to the kolibri_explore_plugin/apps
folder. Note that
this is not ideal, because you should know where has pip
installed
the plugin.
Download the JSON files from the
endless-key-collections
repo and place them in kolibri_explore_plugin/static/collections/
.
Now start Kolibri. You should be able to navigate to /explore
if /
doesn't redirect you already.
Make sure you already have the latest pipenv
.
Either if you want to build or develop the plugin, please run:
./scripts/bootstrap.sh
Just like Kolibri, we use a Python virtual environment along with Node to obtain the exact same dependencies.
.whl
fileWith all the dependencies installed, it's now possible to build the plugin by running:
yarn build-dist
A .whl
file will be created in the dist/
folder. You
can then install it:
pip install dist/kolibri_explore_plugin-*.whl
Tests for the Python backend can be run by executing python -m pytest
or yarn run test:python
. See the plugin
test
directory for more details about
the Python testing infrastructure.
For developing you could build and install the .whl
file over and
over for each iteration. But is much easier to install the project in
editable mode, which basically creates a symlink:
pip install --editable .
Note: you still need to enable the plugin and run migrations as in Usage above!
Then serve the plugin in watch mode:
yarn dev
Usually you will also be developing Kolibri, as described in the Kolibri developer documentation.
So probably you have the following running in another Terminal tab:
yarn run devserver-hot
And you can edit both the plugin and Kolibri in live-mode. Further, you can also edit a custom channel presentation in another Terminal tab. See "Developing custom channel presentations" section below.
To run checks before any commit just run this command:
pre-commit install -f --install-hooks
There is a continuous integration tool in Github that will run the same checks for each pull request.
There is a Github action that does this automatically on each release. To do it locally yourself:
yarn build:apps
All custom presentation app bundles should be added in the
kolibri_explore_plugin/apps
directory to have this fully working.
The zip bundle should be named custom-channel-ui.zip
and it should
be placed inside the corresponding app folder.
Instead of bundling the custom channel presentation inside the apps directory, it's possible to work with a proxy for development. Note that the proxy will be used for all the channels, not only for the channel in question.
$ cd packages/template-ui
$ yarn serve
PROXY_CUSTOM_CHANNEL
environment variable
enabled:$ cd /PATH/TO/kolibri
$ PROXY_CUSTOM_CHANNEL=1 yarn run devserver-hot
Every request to the custom-channel-ui.zip
will be proxied to the
devserver. The hot reloading should work here too!
Make sure to have a .env
file with the spreadsheet key as content:
CONTENT_SPREADSHEET_KEY=123456
Then run the script:
./scripts/ingest_highlighted.py
If everything goes well, the highlighted-content.json
file will be
updated. You then need to commit the file.
Triggering Bump version to release
action from bump2release.yml
will do all release steps mentioned in
Release with local environment
automatically, including:
To release a new version first please bump the version number to either major or minor. Note that the major version also needs a version name for branding. For example:
# For a minor release:
yarn bump-version minor
# For a major release:
yarn bump-version major "Komodo Dragon"
That creates a new commit and a git tag. Please push them to the remote:
git push
git push origin NEW_TAG
The bump-version
script can also be run with options such as
--dry-run --list
or --no-commit
to see what will happen. You can
also specify --current-version
to see the effect without actually
changing the current version. See bumpversion --help
for all options.
PyPI and pip
support release candidates with the rc<N>
suffix. Prior
to major releases it may be helpful to build and publish release
candidates so they can be tested prior to general availability. Our
bumpversion
configuration has limited support for release candidates,
so care should be taken to ensure the new version comes out correctly.
To begin a release candidate series, the version must be fully specified:
yarn bump-version major "Komodo Dragon" --new-version 7.0.0rc1
To make the next release candidate, run:
yarn bump-version rc
Finally, to end a release candidate series, the version must be fully specified again:
yarn bump-version major "Komodo Dragon" --new-version 7.0.0
In all cases, the commit and tag must be pushed to the remote as explained above.
To show the build information in the front page, as a tag in top right corner,
you can set the environment variable, SHOW_BUILD_INFO
to "true", for example,
for the development kolibri server:
$ SHOW_BUILD_INFO=true yarn run devserver