forked from openedx/edx-platform
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat!: expose per-release edx-sandbox dependency pins
See requirements/edx-sandbox/README.rst for more info BREAKING CHANGE: edx-sandbox/py38.txt will not longer be updated. Please install from either edx-sandbox/base.txt or edx-sandbox/releases/*.txt instead.
- Loading branch information
1 parent
a17e2c0
commit 7e96b32
Showing
5 changed files
with
72 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
edx-sandbox: a Python environment for sandboxed execution with CodeJail | ||
####################################################################### | ||
|
||
The requirements in this directory describe a Python environment separate from | ||
the general edx-platform environment. When correctly configured with | ||
`CodeJail <https://github.com/openedx/codejail>`_, edx-platform can use | ||
it to execute untrusted code, particularly instructor-authored Python code | ||
within ``<script type="loncapa/python">`` ProblemBlock tags. | ||
|
||
Files in this directory | ||
*********************** | ||
|
||
base.in | ||
======= | ||
|
||
This is the current set of requirements or the edx-sandbox | ||
environment, and it is used to generate the ``.txt`` files described below. | ||
These requirements share some constraints with the general edx-platform | ||
requirements (via ``../constraints.txt``), but otherwise, they are completely | ||
separate. | ||
|
||
We do not recommend installing from this file directly, because | ||
the packages are not pinned. | ||
|
||
base.txt | ||
======== | ||
|
||
These are the latest requirement pins for edx-sandbox. | ||
They are regularly updated with the latest compatible versions of each package. | ||
|
||
Install from this file if you wish to always run the latest edx-sandbox | ||
environment. Take note that there will periodically be breaking changes to | ||
``base.txt``. For example, we may update the Python version used to generate | ||
the pins, which may break edx-sandbox environments running older Python | ||
versions. | ||
|
||
releases/(RELEASE_NAME).txt | ||
=========================== | ||
|
||
*e.g. releases/redwood.txt, releases/sumac.txt, etc.* | ||
|
||
Starting with Quince, every named Open edX release adds one of these files. | ||
They contain the requirement pins corresponding to ``base.txt`` at the time | ||
of each release. | ||
|
||
Install from one of these files if you want to run a stable edx-sandbox | ||
environment without breaking changes. | ||
|
||
Support windows | ||
*************** | ||
|
||
Only ``base.txt`` and the latest ``release/*.txt`` from the latest named | ||
release are supported by the Open edX community. However, we will leave | ||
old ``release/*.txt`` files in the repository to assist: | ||
|
||
* operators who want to stagger their edx-sandbox upgrade from their general | ||
edx-platform upgrade | ||
* operators who need to temporarily roll back their edx-sandbox environments | ||
so that instructors can fix their loncapa Python code. |
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.