completion
Purpose
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.
Enabling in the LMS
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.
Getting Started with Development
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 django52-drflatest
To use a Django shell to test commands:
make requirements
python manage.py migrate
python manage.py shell
>>> from completion.models import BlockCompletion
>>> <other commands...>
Deploying
Merges to master are released to pypi.org automatically by python-semantic-release.
To use the latest release in your project, add the following to your pip requirements file:
edx-completion
Getting Help
Documentation
Start by going through the documentation (generated from /docs). If you need more help see below.
License
The code in this repository is licensed under version 3 of the AGPL unless otherwise noted.
Please see LICENSE for details.
Contributing
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.
The Open edX Code of Conduct
All community members are expected to follow the Open edX Code of Conduct.
People
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.
Reporting Security Issues
Please do not report security issues in public. Please email security@openedx.org.
Metadata
Release files for edx-completion 5.1.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 | Actions |
|---|---|---|---|---|
| edx_completion-5.1.0.tar.gz | 42.6 kB | With provenance | Details for edx_completion-5.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| edx_completion-5.1.0-py3-none-any.whl | Python 3 | none | any | Details for edx_completion-5.1.0-py3-none-any.whl |
Total release size: 80.2 kB
Release files / edx_completion-5.1.0.tar.gz
| Download URL | edx_completion-5.1.0.tar.gz |
|---|---|
| Size | 42.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a0a5f2586fd204c39383b82ed11012a4d7f33b5187310bcff110e9bc43671617
|
|
BLAKE2b-256 checksum How to use checksums |
ca14cd3c84372f88101d084bfbf5dac4126101686b068968ef747af59b449a62
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 6, 2026.
Transparency logRelease files / edx_completion-5.1.0-py3-none-any.whl
| Download URL | edx_completion-5.1.0-py3-none-any.whl |
|---|---|
| Size | 37.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
03269c8ecb65da764c1e8cb6c6faed60f71d35183229260a86b311e53b509812
|
|
BLAKE2b-256 checksum How to use checksums |
80a683a6b7e9e5d9a513da26efc9b66da4941bb15b774bdbd4a255c626c43d5c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
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.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 6, 2026.
Transparency logSecurity for edx-completion 5.1.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.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for edx_completion-5.1.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 6, 2026.
Transparency logA 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.