feat: allows you to add extra pip requirements to your codejail sandb…

…ox DS-697 (#42) * feat: allows you to add extra pip requirements to your codejail sandbox * docs: update the readme to add the new feature
eduNEXT · Nov 18, 2023 · ec78ac6 · ec78ac6
1 parent ede19c8
commit ec78ac6
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -43,6 +43,13 @@ Configuration
 - ``CODEJAIL_ENABLE_K8S_DAEMONSET`` (default: ``False``)
 - ``CODEJAIL_SKIP_INIT`` (default: ``False``)
 - ``CODEJAIL_SANDBOX_PYTHON_VERSION`` (default: ``3.8.6``)
+- ``CODEJAIL_EXTRA_PIP_REQUIREMENTS`` (optional) A list of pip requirements to add to your sandbox.
+
+    .. code-block:: yaml
+
+        CODEJAIL_EXTRA_PIP_REQUIREMENTS:
+        - pybryt
+
 
 Compatibility
 -------------

diff --git a/tutorcodejail/templates/codejail/build/codejail/Dockerfile b/tutorcodejail/templates/codejail/build/codejail/Dockerfile
@@ -54,6 +54,12 @@ RUN mkdir -p common/lib/
 COPY --from={{ DOCKER_IMAGE_OPENEDX }} /openedx/edx-platform/requirements/edx-sandbox/py38.txt py38.txt
 RUN pip3 install -r py38.txt
 
+# Allows you to add extra pip requirements to your codejail sandbox.
+{% if CODEJAIL_EXTRA_PIP_REQUIREMENTS is defined %}
+{% for extra_requirements in CODEJAIL_EXTRA_PIP_REQUIREMENTS %}RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/openedx/.cache/pip,sharing=shared {% endif %}pip install '{{ extra_requirements }}'
+{% endfor %}
+{% endif %}
+
 ##### Prod image
 FROM minimal as production