Add README explaining normal/codejail requirements split (#25037)

This commit is contained in:
Tim McCormack
2020-09-28 13:25:11 -04:00
committed by GitHub
parent 6f69fd7dc2
commit 62ecf6dde9

10
requirements/README.rst Normal file
View File

@@ -0,0 +1,10 @@
These directories specify the Python (and system) dependencies for the LMS and Studio.
- ``edx`` contains the normal Python requirements files
- ``edx-sandbox`` contains the requirements files for Codejail
- ``constraints.txt`` is shared between the two
(In a normal `OEP-18`_-compliant repository, the ``*.in`` and ``*.txt`` files would be
directly in the requirements directory.)
.. _OEP-18: https://github.com/edx/open-edx-proposals/blob/master/oeps/oep-0018-bp-python-dependencies.rst