search

cookiecutter-openedx / openedx-plugin-example

Python-Django scaffolding for common use cases
GNU Affero General Public License v3.0
14 stars 7 forks source link

Quickstart Deprecated in favour of launch #21

Closed graeme44 closed 3 months ago

graeme44 commented 4 months ago

Quickstart has been Deprecated in favour of launch (as of Tutor v15.1.0)

graeme44 commented 4 months ago

Also getting an error when trying to set up plugins using tutor, version 17.0.3:

tutor local run lms ./manage.py lms openedx_plugin_api_init
docker compose -f '/Users/x/Library/Application Support/tutor/env/local/docker-compose.yml' -f '/Users/x/Library/Application Support/tutor/env/local/docker-compose.prod.yml' --project-name tutor_local run --rm lms ./manage.py lms openedx_plugin_api_init
[+] Creating 6/0
 ✔ Container tutor_local-smtp-1           Running                                                             0.0s
 ✔ Container tutor_local-mysql-1          Running                                                             0.0s
 ✔ Container tutor_local-permissions-1    Created                                                             0.0s
 ✔ Container tutor_local-redis-1          Running                                                             0.0s
 ✔ Container tutor_local-mongodb-1        Running                                                             0.0s
 ✔ Container tutor_local-elasticsearch-1  Running                                                             0.0s
[+] Running 1/1
 ✔ Container tutor_local-permissions-1  Started                                                               0.2s
Unknown command: 'openedx_plugin_api_init'
Type 'manage.py help' for usage.
Error: Command failed with status 1: docker compose -f /Users/x/Library/Application Support/tutor/env/local/docker-compose.yml -f /Users/x/Library/Application Support/tutor/env/local/docker-compose.prod.yml --project-name tutor_local run --rm lms ./manage.py lms openedx_plugin_api_init

Interestingly, I also had to create the requirements dir in $(tutor config printroot)/env/build/openedx – not sure if this is related to the new Tutor versions.

It seems that private.txt has also been deprecated.

lpm0073 commented 3 months ago

@graeme44 , the command 'openedx_plugin_api_init' is a manage.py command that's part of this repo, and is located here. The error that you're seeing means that this plugin is not part of the build that you're running.

one simple way of verifying what is/isn't included in your build is to use tutor to start a terminal session inside the lms pod, and then run pip list to generate a list of all pip-installed packages. you should see this repo listed.

graeme44 commented 3 months ago

Thanks @lpm0073, I see you have updated the README to use launch. The second issue is that private.txt has been deprecated (as of v17.0.0):

[Deprecation] Adding Python packages to edx-platform via private.txt is no longer supported. Instead, users should bind-mount their requirement directories with tutor mounts add ....

So pip list doesn't show this package, as it is not being installed.

graeme44 commented 3 months ago

Closing, opened a new issue #22