Kolibri Sync Extras plugin
What is this?
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. See learningequality.org/kolibri for more info.
Kolibri supports syncing facility data between two instances. This plugin provides additional sync related features that can be turned on to customize the behavior of those syncs. In particular, these features can enhance Kolibri's syncing mechanism when dealing with a large database or dataset.
How can I install this plugin?
-
Inside your Kolibri virtual environment:
pip install kolibri-sync-extras-plugin -
Activate the plugin:
kolibri plugin enable kolibri_sync_extras_plugin -
Restart Kolibri
Plugin configuration
The following configuration options are available, and should be defined within the [Sync] section of $KOLIBRI_HOME/options.ini or define environment variables with the prefix KOLIBRI_SYNC_.
| Option | Type | Default | Description |
|---|---|---|---|
BACKGROUND_INITIALIZATION |
Boolean | False |
Whether to enable background initialization of pull syncs |
BACKGROUND_INITIALIZATION_STAGES |
String | serializing,queuing |
Comma separated list of stages for which to enable background initialization |
BACKGROUND_FINALIZATION |
Boolean | False |
Whether to enable background finalization of push syncs |
BACKGROUND_FINALIZATION_STAGES |
String | dequeuing,deserializing,cleanup |
Comma separated list of stages for which to enable background finalization |
Example
[Sync]
BACKGROUND_INITIALIZATION = True
BACKGROUND_INITIALIZATION_STAGES = "serializing"
BACKGROUND_FINALIZATION = True
BACKGROUND_FINALIZATION_STAGES = "deserializing,cleanup"
Development
Getting started
$ uv sync
$ uvx prek install
$ KOLIBRI_HOME="$(pwd)/.kolibri" uv run kolibri plugin enable kolibri_sync_extras_plugin
Testing
Getting started
$ uv sync --group test
$ KOLIBRI_HOME="$(pwd)/.kolibri" uv run kolibri plugin enable kolibri_sync_extras_plugin
Running them
$ pytest test/
Release files for kolibri-sync-extras-plugin 0.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| kolibri_sync_extras_plugin-0.3.0.tar.gz | 43.0 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| kolibri_sync_extras_plugin-0.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 54.2 kB
Release files / kolibri_sync_extras_plugin-0.3.0.tar.gz
| Download URL | kolibri_sync_extras_plugin-0.3.0.tar.gz |
|---|---|
| Size | 43.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0eb6bde62c1e9a2072d8aa08b3b0e4e94c4918336d5544860f7f85cc5abf275c
|
|
BLAKE2b-256 checksum How to use checksums |
e4ff2f492d537745e4e5fcd1a1b4211e2dc42c2d77f80c7b9730198e48ed44a0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / kolibri_sync_extras_plugin-0.3.0-py3-none-any.whl
| Download URL | kolibri_sync_extras_plugin-0.3.0-py3-none-any.whl |
|---|---|
| Size | 11.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
71fbb697bfd758fb4bbb0a4dcd876d83b316239385ef0dc8345fc81b1cb162d1
|
|
BLAKE2b-256 checksum How to use checksums |
1fbdd44bcc9e0db66aa2ed570a35b087a7c7ca9859ab0a67bbb1b4387dd7a713
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for kolibri-sync-extras-plugin 0.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
