A collection of XBlocks for the Open edX platform.
This repository serves as the consolidated home for several previously standalone XBlock packages, brought together to streamline maintenance and simplify dependency management. These XBlocks are not installed by default in the Open edX platform but can be added as needed. Each XBlock preserves its original package path to serve as a drop-in replacement when migrating from the standalone packages.
The following XBlocks have been migrated here from their respective repositories:
- AudioXBlock migrated from
- FeedbackXBlock migrated from
- Free Text Response XBlock migrated from
- xblock-image-modal migrated from
- xblock-qualtrics-survey migrated from
- xblock-sql-grader migrated from
- xblock-submit-and-compare migrated from
If you currently have any of the standalone packages listed above
installed, you should migrate to xblocks-extra.
See the Migration Guide for the instructions.
pip install xblocks-extra- Python 3.12+
- Django 4.2 or 5.2
# Clone the repository
git clone https://github.com/openedx/xblocks-extra.git
cd xblocks-extra
# Install in development mode
pip install -e ".[dev]"make testmake lint
make format # Auto-fix formatting issuesInternationalization (i18n) is when a program is made aware of multiple languages. Localization (l10n) is adapting a program to local language and cultural habits.
This project follows OEP-58 for centralized
translation management via the openedx-translations repository.
The daily extraction workflow in openedx-translations clones this repo, runs make extract_translations, and pushes
the combined source .po file to Transifex for the translation community to translate.
edx-i18n-tools(included in[dev]dependencies)gettextsystem package (brew install gettexton macOS,sudo apt install gettexton Ubuntu)
- Mark translatable strings in Python and JavaScript using
gettext/ugettext. - Extract source strings:
make extract_translations - Compile translations:
make compile_translations
| Target | Description |
|---|---|
extract_translations | Extract translatable strings from all XBlocks into per-xblock text.po files, then merge into a combined conf/locale/en/LC_MESSAGES/django.po for OEP-58 |
compile_translations | Compile .po files into .mo message files for each XBlock |
dummy_translations | Generate dummy (Esperanto) .po files for testing |
build_dummy_translations | Extract, generate dummy, and compile translations |
validate_translations | Build dummy translations and detect changed source files |
detect_changed_source_translations | Check if source .po files are up-to-date |
pull_translations | Pull translations from Transifex |
push_translations | Extract and push source translations to Transifex |
install_transifex_client | Install the Transifex CLI client |
Each XBlock in src/ has its own conf/locale/ directory with a config.yaml and .tx/config.
During extraction:
i18n_tool extractruns in each XBlock directory, producingdjango.po(and optionallydjangojs.po).- If
djangojs.poexists, it is merged intodjango.pousingmsgcat. - The merged file is renamed to
text.po. - All per-xblock
text.pofiles are combined viamsgcat --use-firstinto a singleconf/locale/en/LC_MESSAGES/django.poat the repository root for the openedx-translations pipeline.
# Dry-run extraction
make extract_translations
# Check the combined output
cat conf/locale/en/LC_MESSAGES/django.po
# Build and test with dummy translations
make build_dummy_translations
# Verify Transifex config (requires tx CLI)cd src/<xblock_name>&& tx statusNote: The
.gitignoreignores*.poand*.mofiles. This is expected — translation source files are managed in the openedx-translations repository, not committed here.
Contributions are welcome! Please read our contributing guidelines before submitting a pull request.
This project is licensed under the AGPL-3.0 License - see the LICENSE file for details.