an app that aggregates block level completion data for different block types for Open edX.
Project description
openedx-completion-aggregator is a Django app that aggregates block level completion data for different block types for Open edX.
Overview
openedx-completion-aggregator uses the pluggable django app pattern to ease installation. To use in edx-platform, do the following:
Install the app into your virtualenv.
..code_block:
$ pip install openedx-completion-aggregator
[Optional] You may override the set of registered aggregator block types in your lms.env.json file:
... "COMPLETION_AGGREGATOR_BLOCK_TYPES": { "course", "chapter", "subsection", "vertical" }, ...
By default, completion is aggregated with each created or updated BlockCompletion. If this creates too much database activity for your installation, set the following in your lms.env.json file:
... "COMPLETION_AGGREGATOR_ASYNC_AGGREGATION": true, ...
Then configure up a pair of cron jobs to run ./manage.py run_aggregator_service and ./manage.py run_aggregator_cleanup as often as desired.
Note that if operating on a Hawthorne-or-later release of edx-platform, you may override the settings in EDXAPP_ENV_EXTRA instead.
Documentation
The full documentation is at https://openedx-completion-aggregator.readthedocs.org.
License
The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.
Please see LICENSE.txt for details.
How To Contribute
Contributions are very welcome.
Please read How To Contribute for details.
Even though they were written with edx-platform in mind, the guidelines should be followed for Open edX code in general.
PR description template should be automatically applied if you are sending PR from github interface; otherwise you can find it it at PULL_REQUEST_TEMPLATE.md
Issue report template should be automatically applied if you are sending it from github UI as well; otherwise you can find it at ISSUE_TEMPLATE.md
Reporting Security Issues
Please do not report security issues in public. Please email help@opencraft.com.
Getting Help
Have a question about this repository, or about Open edX in general? Please refer to this list of resources if you need any assistance.
Change Log
Unreleased
[1.0.0] - 2018-01-04
First release on PyPI.
On-demand asynchronous aggregation of xblock completion.
Provides an API to retrieve aggregations for one or many users, for one or many courses.
Project details
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
Hashes for openedx-completion-aggregator-1.5.7.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 76559c7f4726e69b5ef4ae98bb360b5479e758871901a486db65afdef5438c71 |
|
MD5 | 77c175d9d7737582a36e80438ad94964 |
|
BLAKE2b-256 | b0a54271dab26a083260c0f117832368114b2370fd1571839d74bfe0f1f22b32 |
Hashes for openedx_completion_aggregator-1.5.7-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9fe6d692adca36bd3169cc90af483428ae587419fef9f4395ff56de6af227f38 |
|
MD5 | 88294b58cf18c66077ca51c5dbe34bde |
|
BLAKE2b-256 | a60fddb1fde654eebdceb132ab192406932b458cd9c378516a318bbffd432b7c |