openedx / openedx-k8s-harmony

A Prototype Helm Chart for deploying multiple Open edX instances (via Tutor) onto a cluster.
GNU Affero General Public License v3.0
10 stars 14 forks source link

Add __init__.py to harmony_search #67

Closed mtyaka closed 8 months ago

mtyaka commented 8 months ago

Without this, the module does not get installed correctly when installing the package with pip.

Test instructions:

  1. Create a fresh virtual environment.
  2. Install harmony plugin without this patch: pip install "git+https://github.com/openedx/openedx-k8s-harmony.git@harmony-chart-0.5.1#egg=tutor-contrib-harmony-plugin&subdirectory=tutor-contrib-harmony-plugin"
  3. Start the python interpreter and try to import the harmony_search module: from tutor_k8s_harmony_plugin.harmony_search.base import BaseSearchAPI; you will get an import error
  4. Uninstall the plugin and re-install a version with this patch: pip uninstall -y tutor-contrib-harmony-plugin && pip install "git+https://github.com/open-craft/openedx-k8s-harmony.git@mtyaka/add-init-files#egg=tutor-contrib-harmony-plugin&subdirectory=tutor-contrib-harmony-plugin"
  5. Run the python interpreter again and verify that you can successfully import the module this time: from tutor_k8s_harmony_plugin.harmony_search.base import BaseSearchAPI
openedx-webhooks commented 8 months ago

Thanks for the pull request, @mtyaka! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

mtyaka commented 8 months ago

@mtyaka Could you please bump the version number in the __about__.py?

@gabor-boros Done. I set it to 0.5.1 to match the value in Chart.yaml.

openedx-webhooks commented 8 months ago

@mtyaka šŸŽ‰ Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.