[POC] feat: add course translations plugin (#650)

* [POC] feat: add course translations plugin

* rename dir

* fmt

* disable pre-commit errors for now

* disable pre-commit errors for now

* refactor

* fix translated archive name

* pre-commit

* more pre-commit fixes

* more pre-commit fixes

* more pre-commit fixes

* more pre-commit fixes

* update readme

* create tar.gz instead of zip and remove the extracted and translated directories

* use same directory to create translated course

* review changes

* review changes

* review changes

* fmt

* review changes

Author: asadali145

AGENTS.md

@@ -20,6 +20,7 @@ edx-extensions/
 │   ├── ol_openedx_chat/         # Chat integration
 │   ├── ol_openedx_chat_xblock/  # Chat XBlock
 │   ├── ol_openedx_course_sync/  # Course synchronization
+│   ├── ol_openedx_course_translations/  # Course translations
 │   ├── ol_openedx_git_auto_export/ # Git export automation
 │   ├── ol_openedx_logging/      # Logging enhancements
 │   ├── ol_openedx_otel_monitoring/ # OpenTelemetry monitoring

setup.cfg

@@ -27,7 +27,7 @@ exclude =
     __pycache__
 
 [mypy]
-python_version=3.8
+python_version=3.11
 ignore_missing_imports=True
 
 [darglint]

src/ol_openedx_course_translations/CHANGELOG.rst

@@ -0,0 +1,11 @@
+Change Log
+----------
+
+..
+   All enhancements and patches to ol_openedx_chat will be documented
+   in this file.  It adheres to the structure of https://keepachangelog.com/ ,
+   but in reStructuredText instead of Markdown (for ease of incorporation into
+   Sphinx documentation and the PyPI description).
+
+   This project adheres to Semantic Versioning (https://semver.org/).
+.. There should always be an "Unreleased" section for changes pending release.

src/ol_openedx_course_translations/LICENSE.txt

@@ -0,0 +1,28 @@
+Copyright (C) 2022  MIT Open Learning
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

src/ol_openedx_course_translations/README.rst

@@ -0,0 +1,52 @@
+OL Open edX Course Translations
+###############
+
+An Open edX plugin to manage course translations.
+
+Purpose
+*******
+
+Translate course content into multiple languages to enhance accessibility for a global audience.
+
+Setup
+=====
+
+For detailed installation instructions, please refer to the `plugin installation guide <../../docs#installation-guide>`_.
+
+Installation required in:
+
+* Studio (CMS)
+
+Configuration
+=============
+
+1. edx-platform configuration
+-----------------------------
+
+- Add the following configuration values to the config file in Open edX. For any release after Juniper, that config file is ``/edx/etc/lms.yml``. If you're using ``private.py``, add these values to ``lms/envs/private.py``. These should be added to the top level. **Ask a fellow developer for these values.**
+
+  .. code-block:: python
+
+       DEEPL_API_KEY: <YOUR_DEEPL_API_KEY_HERE>
+
+- For Tutor installations, these values can also be managed through a `custom Tutor plugin <https://docs.tutor.edly.io/tutorials/plugin.html#plugin-development-tutorial>`_.
+
+Usage
+====================
+1. Open the course in Studio.
+2. Go to Tools -> Export Course.
+3. Export the course as a .tar.gz file.
+4. Go to the CMS shell
+5. Run the management command to translate the course:
+
+   .. code-block:: bash
+
+        ./manage.py cms translate_course --source-language <SOURCE_LANGUAGE_CODE, defaults to `EN`> --translation-language <TRANSLATION_LANGUAGE_CODE i.e. AR> --course-dir <PATH_TO_EXPORTED_COURSE_TAR_GZ>
+
+License
+*******
+
+The code in this repository is licensed under the AGPL 3.0 unless
+otherwise noted.
+
+Please see `LICENSE.txt <LICENSE.txt>`_ for details.

src/ol_openedx_course_translations/ol_openedx_course_translations/__init__.py

@@ -0,0 +1,3 @@
+"""
+MIT's Open edX course translations plugin
+"""

src/ol_openedx_course_translations/ol_openedx_course_translations/apps.py

@@ -0,0 +1,23 @@
+"""
+ol_openedx_course_translations Django application initialization.
+"""
+
+from django.apps import AppConfig
+from edx_django_utils.plugins import PluginSettings
+from openedx.core.djangoapps.plugins.constants import ProjectType, SettingsType
+
+
+class OLOpenedXCourseTranslationsConfig(AppConfig):
+    """
+    Configuration for the ol_openedx_course_translations Django application.
+    """
+
+    name = "ol_openedx_course_translations"
+
+    plugin_app = {
+        PluginSettings.CONFIG: {
+            ProjectType.CMS: {
+                SettingsType.COMMON: {PluginSettings.RELATIVE_PATH: "settings.common"},
+            },
+        },
+    }