Registry / web-framework / edx-completion

edx-completion

library5.0.0pypypiunverified

A Django app for tracking completion of blocks by learners in edX courses. Current version 5.0.0. Release cadence is irregular, with frequent dependency upgrades and occasional feature drops.

web-framework database

pip install edx-completion

github ↗package ↗

INSTALL

IMPORT

SIG · EDX-COMPLETION

edx-completion

web-frameworkpythonv5.0.0

Install

13.2s avg

Import

—

Disk

174MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v5.0.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 165.6MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 13.2s · import 0.000s · 172MB

174MB installed

● package 174MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

BlockCompletion

✓ from completion.models import BlockCompletion

✗ from completion.models import BlockCompletion

Submit a completion and query completions.

from completion.api import submit_completion from completion.models import BlockCompletion # Submit a completion for a block block_key = 'block-v1:Org+Course+Run+type@problem+block@abc123' user_id = 1 course_key = 'course-v1:Org+Course+Run' submit_completion( user_id=user_id, course_key=course_key, block_key=block_key, completion=1.0 ) # Query existing completions completions = BlockCompletion.objects.filter(user_id=user_id, course_key=course_key) print(list(completions))

Debug

Known issues

gotchaThe `submit_completion` function expects `course_key` and `block_key` as strings (serialized opaque keys), not objects. Using `CourseKey` or `BlockUsageLocator` objects will raise a TypeError.

fix

Ensure keys are stringified via `str(course_key)` before calling submit_completion.

affects: >=4.0.0

breakingIn v5.0.0, support for Python 3.8 was dropped. If your project uses Python 3.8, you must upgrade.

fix

Use Python 3.10 or later.

affects: >=5.0.0

deprecatedThe `get_completions` function in `completion.api` was deprecated in v4.x and removed in v5.0.0. Use `BlockCompletion.objects.filter(...)` instead.

fix

Replace `get_completions(...)` with `BlockCompletion.objects.filter(...)`.

affects: >=5.0.0

Upgrade

Version history

5.0.0latest on PyPI · released Apr 7, 2026

Audit

Dependencies

DjangorequiredRequired as a Django app.

edx-opaque-keysrequiredFor BlockUsageLocator and other key types.

Agent activity

7 hits · last 30 days

node

Resources

githubhttps://github.com/openedx/completion ↗

packagehttps://pypi.org/project/edx-completion/ ↗