Kolibri plugin for rendering Khan Academy Perseus style exercises
Project description
Perseus Exercise Renderer for Kolibri
=====================================
What is Kolibri?
----------------
Kolibri is a Learning Management System / Learning App designed to run on low-power devices, targeting the needs of
learners and teachers in contexts with limited infrastructure. A user can install Kolibri and serve the app on a local
network, without an internet connection. Kolibri installations can be linked to one another, so that user data and
content can be shared. Users can create content for Kolibri and share it when there is network access to another
Kolibri installation or the internet.
See https://learningequality.org/kolibri/ for more info.
What is Perseus?
----------------
Khan Academy's exercise question editor and renderer.
See https://github.com/Khan/perseus for more info.
What is this plugin?
--------------------
A Perseus renderer wrapper for Kolibri that can track learning progress and save to the database.
How can I install this plugin?
------------------------------
1. Inside your Kolibri virtual environment:
``pip install kolibri-perseus-exercise-plugin``
2. Activate the plugin:
``kolibri plugin exercise_perseus_renderer enable``
3. Restart Kolibri.
How can I install this plugin for development?
------------------------------
1. Download this repo.
2. Open terminal in your Kolibri repo.
3. run the following commands:
``pip install -e <KOLIBRI-PERSEUS-PLUGIN-LOCAL-PATH>``
``kolibri plugin kolibri_exercise_perseus_plugin enable``
4. Then run the commands to install frontend packages in Kolibri, this plugin will have its dependencies recursively installed:
``yarn install``
5. Finally, to copy over Mathjax into the static folder, run the following command (you will need to do this if you update the version of Perseus in the repo also):
``./update_perseus.sh``
Updating translation strings
----------------------------
To download the latest translation strings for this plugin, make a `crowdinSecrets.js` file from the template in the repo root, and put your kolibri project API key in there. The KA API key can be set to null. Then execute the following commands:
``cd kolibri_exercise_perseus_plugin``
``yarn run download-translations``
Known issues
------------
If you ran `make dist` or `make pex` on Kolibri with `kolibri-exercise-perseus-plugin==x.x.x` present in `kolibri/requirements/base.txt`, Kolibri will generate a exercise_perseus_renderer instance inside its `dist` folder and use it afterwards. That means manually installing exercise_perseus_renderer for development won't take any effects. One way to fix this issue is to restore the `dist` folder.
How to publish to PyPi?
------------------------------
1. Follow the instructions above to installing the plugin for development.
2. From the Kolibri directory run the frontend build command.
3. update `setup.py` to a newer version.
4. Terminal move to the root level of repo dir and run the following command to publish to PyPi:
``make release``
How can I contribute?
---------------------
* `Documentation <http://kolibri.readthedocs.org/en/latest/>`_ is available online, and in the ``docs/`` directory.
* Mailing list: `Google groups <https://groups.google.com/a/learningequality.org/forum/#!forum/dev>`_.
* IRC: #kolibri on Freenode
=====================================
What is Kolibri?
----------------
Kolibri is a Learning Management System / Learning App designed to run on low-power devices, targeting the needs of
learners and teachers in contexts with limited infrastructure. A user can install Kolibri and serve the app on a local
network, without an internet connection. Kolibri installations can be linked to one another, so that user data and
content can be shared. Users can create content for Kolibri and share it when there is network access to another
Kolibri installation or the internet.
See https://learningequality.org/kolibri/ for more info.
What is Perseus?
----------------
Khan Academy's exercise question editor and renderer.
See https://github.com/Khan/perseus for more info.
What is this plugin?
--------------------
A Perseus renderer wrapper for Kolibri that can track learning progress and save to the database.
How can I install this plugin?
------------------------------
1. Inside your Kolibri virtual environment:
``pip install kolibri-perseus-exercise-plugin``
2. Activate the plugin:
``kolibri plugin exercise_perseus_renderer enable``
3. Restart Kolibri.
How can I install this plugin for development?
------------------------------
1. Download this repo.
2. Open terminal in your Kolibri repo.
3. run the following commands:
``pip install -e <KOLIBRI-PERSEUS-PLUGIN-LOCAL-PATH>``
``kolibri plugin kolibri_exercise_perseus_plugin enable``
4. Then run the commands to install frontend packages in Kolibri, this plugin will have its dependencies recursively installed:
``yarn install``
5. Finally, to copy over Mathjax into the static folder, run the following command (you will need to do this if you update the version of Perseus in the repo also):
``./update_perseus.sh``
Updating translation strings
----------------------------
To download the latest translation strings for this plugin, make a `crowdinSecrets.js` file from the template in the repo root, and put your kolibri project API key in there. The KA API key can be set to null. Then execute the following commands:
``cd kolibri_exercise_perseus_plugin``
``yarn run download-translations``
Known issues
------------
If you ran `make dist` or `make pex` on Kolibri with `kolibri-exercise-perseus-plugin==x.x.x` present in `kolibri/requirements/base.txt`, Kolibri will generate a exercise_perseus_renderer instance inside its `dist` folder and use it afterwards. That means manually installing exercise_perseus_renderer for development won't take any effects. One way to fix this issue is to restore the `dist` folder.
How to publish to PyPi?
------------------------------
1. Follow the instructions above to installing the plugin for development.
2. From the Kolibri directory run the frontend build command.
3. update `setup.py` to a newer version.
4. Terminal move to the root level of repo dir and run the following command to publish to PyPi:
``make release``
How can I contribute?
---------------------
* `Documentation <http://kolibri.readthedocs.org/en/latest/>`_ is available online, and in the ``docs/`` directory.
* Mailing list: `Google groups <https://groups.google.com/a/learningequality.org/forum/#!forum/dev>`_.
* IRC: #kolibri on Freenode
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file kolibri_exercise_perseus_plugin-0.7.5.tar.gz.
File metadata
- Download URL: kolibri_exercise_perseus_plugin-0.7.5.tar.gz
- Upload date:
- Size: 4.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 328da043624a610287dacf1512f9ad71a388f54e2193e38d0cc24a40a2663674 |
|
| MD5 | 731af1bd5cc1f7f1331661ab7a066227 |
|
| BLAKE2b-256 | 278ab1fa7e9ab930c30aefd1ead89ee35cdadde22c1ceca1013db210d8c9a3f2 |
Provenance
File details
Details for the file kolibri_exercise_perseus_plugin-0.7.5-py2.py3-none-any.whl.
File metadata
- Download URL: kolibri_exercise_perseus_plugin-0.7.5-py2.py3-none-any.whl
- Upload date:
- Size: 4.9 MB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1f8b1d5017918c530af546cbc74bb3a16862d4919671d443e523fc6c434a40a1 |
|
| MD5 | 97ca7c1f17d874c7144af66b6b9b3bad |
|
| BLAKE2b-256 | 72bc9072920cbca6f83ed9f40604572fabeac9b8e515684000d7b1ed288ca903 |
