translatable-xblocks
Purpose
Plugin for adding translation behavior to XBlocks. This plugin assumes:
Translations IDA is setup (https://github.com/edx/ai-translations).
Frontend plugin setup to add translation selector.
When present and enabled, requesting a src_lang and dest_lang as query params in a unit render should request and return translated versions of those XBlocks’ content.
WARNING: This replaces some native XBlocks from edx-platform and replaces them with custom versions. While we only override small portions of functionality, there is a chance this will cause things to “spookily” break. See translatable_xblocks/apps.py for where we do this block replacement.
Guides
Getting Started with Development
See quickstart guide.
Conventions / Rules / Best Practices
Use conventional commits for making commits.
Format files with black. Do this and other fixes automatically with make format.
Squash commits when merging a PR.
Please see also the Open edX documentation for guidance on Python development in this repo.
Testing
Deploying
Getting Help
Documentation
PLACEHOLDER: Start by going through the documentation. If you need more help see below.
(TODO: Set up documentation)
More Help
If you’re having trouble, we have discussion forums at https://discuss.openedx.org where you can connect with others in the community.
Our real-time conversations are on Slack. You can request a Slack invitation, then join our community Slack workspace.
For anything non-trivial, the best path is to open an issue in this repository with as many details about the issue you are facing as you can provide.
https://github.com/edx/translatable-xblocks/issues
For more information about these options, see the Getting Help page.
License
The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.
Please see LICENSE.txt 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.
Change Log
Unreleased
0.1.0 – 2024-03-06
Added
First release on PyPI.
1 maintainer
Metadata
1 maintainer
Release files for translatable-xblocks 1.6.3
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 | |
|---|---|---|---|---|
| translatable_xblocks-1.6.3.tar.gz | 53.3 kB | Without provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| translatable_xblocks-1.6.3-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details |
Total release size: 103.3 kB
Release files / translatable_xblocks-1.6.3.tar.gz
| Download URL | translatable_xblocks-1.6.3.tar.gz |
|---|---|
| Size | 53.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fda915899062935b1ee6339e37b6de507e55f400e2aa09142195581e6b8d3813
|
|
BLAKE2b-256 checksum How to use checksums |
18915277df05902349d2cb690893070016357dad3b13e2e189e67c9ff5317cb5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Release files / translatable_xblocks-1.6.3-py2.py3-none-any.whl
| Download URL | translatable_xblocks-1.6.3-py2.py3-none-any.whl |
|---|---|
| Size | 50.0 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
4019ae818acbd1500c769d4b13bf7f7020b7032f8a2b0e634848b5f7d38e334f
|
|
BLAKE2b-256 checksum How to use checksums |
97acdf5763197e6d2b85e4385c06c2e07eaf308521948d509613f3de8d1334ed
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.9.25
|
Security for translatable-xblocks 1.6.3
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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A 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.
