Code Monkey home page Code Monkey logo

kolibri-sync-extras-plugin's Introduction

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?

  1. Inside your Kolibri virtual environment: pip install kolibri-sync-extras-plugin

  2. Activate the plugin: kolibri plugin enable kolibri_sync_extras_plugin

  3. 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

$ pip install -r requirements-dev.txt
$ pre-commit install
$ KOLIBRI_HOME="$(pwd)/.kolibri" kolibri plugin enable kolibri_sync_extras_plugin

Testing

Getting started

$ pip install -r requirements.txt -r requirements-test.txt
$ KOLIBRI_HOME="$(pwd)/.kolibri" kolibri plugin enable kolibri_sync_extras_plugin

Running them

$ pytest test/

kolibri-sync-extras-plugin's People

Contributors

bjester avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.