openedx-completion-aggregator

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.

Metadata

Release files for openedx-completion-aggregator 1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for openedx-completion-aggregator 1.4
File	Size	Uploaded
openedx-completion-aggregator-1.4.tar.gz	43.1 kB	Sep 25, 2018	Details

Built distribution (wheel)

Table of built distributions (wheels) for openedx-completion-aggregator 1.4
File	Interpreter	ABI	Platform	Reset
openedx_completion_aggregator-1.4-py2.py3-none-any.whl 43.6 kB Sep 25, 2018	Python 3, Python 2	none	any	Details

Total release size: 86.7 kB

Release files / openedx-completion-aggregator-1.4.tar.gz

Download URL	openedx-completion-aggregator-1.4.tar.gz
Size	43.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`67daf625b63cbc2d655df1d19dbcc6d5ce87feda61decfe80127c10d9d9bc0bc`
BLAKE2b-256 checksum How to use checksums	`6d3ed86fe36c1c7759345b25a4b5cba42a001c0907ea5f1bde5add1a59969536`
Upload date	Sep 25, 2018
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.5.6`

Release files / openedx_completion_aggregator-1.4-py2.py3-none-any.whl

Download URL	openedx_completion_aggregator-1.4-py2.py3-none-any.whl
Size	43.6 kB
Tags	Python 2 Python 3
SHA-256 checksum How to use checksums	`0196a4ada11a7c9727a6d09d94a9958cc2f4a8425f140e7fc1d3b848b20ec9f5`
BLAKE2b-256 checksum How to use checksums	`c32ae1f17418b277ca362eef8d8d56d18a0c973a337af69b3e603fb96b15d345`
Upload date	Sep 25, 2018
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/40.4.3 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.5.6`