Done XBlock

3.0.0 verified Fri May 01 auth: no python

An Open edX XBlock that allows learners to mark a unit as 'done', providing a simple way to track completion in courseware. The latest version is 3.0.0, with a maintenance release cadence driven by automated dependency updates.

pip install done-xblock

Common errors

error ModuleNotFoundError: No module named 'donexblock' ↓

cause Installed the package as 'done-xblock' but tried to import a non-existent module 'donexblock'.

fix

Install with pip install done-xblock, then import from donexblock.

error AttributeError: module 'donexblock' has no attribute 'DoneXBlock' ↓

cause Imported 'donexblock' as a module instead of the class.

fix

Use 'from donexblock import DoneXBlock'.

Warnings

gotcha The XBlock must be configured with a proper scope storage; missing settings may cause unexpected behavior. ↓

fix Ensure your Open edX platform version is compatible and follow the configuration guide.

gotcha Version 3.0.0 dropped Python 2 support. Upgrade your environment if still on Python 2. ↓

fix Use Python 3.8+ and pip install done-xblock>=3.0.0

Imports

DoneXBlock
wrong
```
import donexblock
```
correct
```
from donexblock import DoneXBlock
```
XBlock subclasses are typically imported by class name, not module

Quickstart

Basic import and setup for testing the XBlock.

from donexblock import DoneXBlock
# DoneXBlock is typically registered in an Open edX environment via the XBlock registry.
# To test in isolation, you can instanciate it with a runtime:
# from xblock.runtime import KvsRuntime
# runtime = KvsRuntime(...)
# block = DoneXBlock(runtime)
print("DoneXBlock imported successfully")