Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add __init__.py to harmony_search #67

Merged
merged 3 commits into from
Mar 14, 2024

Conversation

mtyaka
Copy link
Contributor

@mtyaka mtyaka commented Mar 11, 2024

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

Without this, the module does not get installed correctly when
installing the package with pip.
@openedx-webhooks
Copy link

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:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Mar 11, 2024
@mtyaka mtyaka requested a review from gabor-boros March 11, 2024 08:21
Copy link
Contributor

@gabor-boros gabor-boros left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I set it to 0.5.1 to match the value in charts/harmony-chart/Chart.yaml.
@mtyaka
Copy link
Contributor Author

mtyaka commented Mar 14, 2024

@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.

Copy link
Contributor

@gabor-boros gabor-boros left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mtyaka I updated the version number to be 0.2.0 instead of 0.5.1. Although I see the point of having matching version numbers, the plugin is basically separate from the chart, it is just shipped in the same repo as the chart. I'm going to quickly approve and merge this change, so we reduce the back and forth.

@gabor-boros gabor-boros merged commit c016924 into openedx:main Mar 14, 2024
2 checks passed
@openedx-webhooks
Copy link

@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.

@gabor-boros gabor-boros deleted the mtyaka/add-init-files branch March 14, 2024 08:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

3 participants