A library for tracking completion of blocks by learners in Open edX courses.

This repository provides a Django model BlockCompletion that is intended to be plugged into edx-platform. It provides various handlers and services for the recording of completion data. It also provides a DRF API for submitting completion data in batches.

By default, the Open edX LMS does not use this library. To turn it on, go to http://your.lms.site/admin/waffle/switch/, and add a new switch with Name completion.enable_completion_tracking and Active selected.

See Completion Tool in the Open edX documentation for details on what will happen once enabled.

Please see the Open edX documentation for guidance on Python development in this repo.

To install the completion app, run these commands from the completion root directory:

pip install -e

To run the test suite:

pip install tox
tox # to run only a single environment, do e.g. tox -e py38-django42-drflatest

To use a Django shell to test commands:

make install
python manage.py migrate
python manage.py shell
>>> from completion.models import BlockCompletion
>>> <other commands...>

Tagged versions of the completion library are released to pypi.org.

To use the latest release in your project, add the following to your pip requirements file:

edx-completion

Start by going through the documentation (generated from /docs). If you need more help see below.

The code in this repository is licensed under version 3 of the AGPL unless otherwise noted.

Please see LICENSE for details.

Contributions are very welcome. Please read How To Contribute for details.

This project is currently accepting all types of contributions, bug fixes, security fixes, maintenance work, or new features. However, please make sure to have a discussion about your new feature idea with the maintainers prior to beginning development to maximize the chances of your change being accepted. You can start a conversation by creating a new issue on this repo summarizing your idea.

All community members are expected to follow the Open edX Code of Conduct.

The assigned maintainers for this component and other project details may be found in Backstage. Backstage pulls this data from the catalog-info.yaml file in this repo.

Please do not report security issues in public. Please email security@openedx.org.