Skip to content

Support for openedx-template-site#38843

Draft
kdmccormick wants to merge 5 commits into
openedx:masterfrom
kdmccormick:kdmccormick/openedx-template-site
Draft

Support for openedx-template-site#38843
kdmccormick wants to merge 5 commits into
openedx:masterfrom
kdmccormick:kdmccormick/openedx-template-site

Conversation

@kdmccormick

Copy link
Copy Markdown
Member

Support for https://github.com/kdmccormick/openedx-template-site

More generally, this is support for running openedx-platform as a pip-installable package of reusable Django apps rather than running openedx-platform's manage.py directly

Work-in-progress.

A step towards making `collectstatic` work outside of
openedx-platform's root dir.
Before this change, openedx-platform deps had to be installed in
two steps (using `pip` or `uv pip`):

   # first, install dependencies. one of the following:
   pip install -r requirements/edx/base.txt
   pip install -r requirements/edx/development.txt
   pip install -r requirements/edx/testing.txt
   pip install -r requirements/edx/doc.txt

   # then, compile metadata for entrypoints:
   pip install -e .

Now, with the dependencies listed in pyproject.toml, it's only one step:

   # one of the following:
   pip install -e '.'
   pip install -e '.[development]'
   pip install -e '.[testing]'
   pip install -e '.[doc]'

BREAKING CHANGE: Running `pip install -e .` or other similar commands
will now install all of openedx-platform's base dependencies. This command
used to run very quickly, but now it will take longer, you may want to
adjust the command's position in your build scripts. Otherwise, this
change is backwards-compatible; it is still fine to run both
`pip install -r <file>` and `pip install -e .`, just redundant.

This brings the project more in line with Python standards and will make
it easier to install and run the platform outside of an environment manager
like Tutor. Note that this commit does NOT do anything to install build
dependencies (assets.txt) in a more standard way; that could be a future work.

Bumps version to 0.14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant