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

xblock-image-explorer | Drop py3.8 support | replace pkg_resource with importlib.resources #153

Merged
merged 7 commits into from
Oct 25, 2024

Conversation

OmerBhatti
Copy link
Contributor

@OmerBhatti OmerBhatti commented Sep 3, 2024

  • Drop Py3.8 support
  • Replace pkg_resources lib with importlib.resources

Ticket: Move on from deprecated pkg_resources api #150

PR is expected to merge after merging this PR : chore: Upgrade Python requirements

Followed migration guide: https://importlib-resources.readthedocs.io/en/latest/migration.html

Testing:
I have tested the changes with following steps:

  • Install xblock-image-explorer into xblock-sdk
  • Test image explorer xblock functionality
  • Run tox tests

Screenshots

image

Resolves #159.

…rces

* chore: transitioned from pkg_resources api to importlib-resources api
* feat!: drop support for python 3.8
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 3, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @OmerBhatti!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Submit a signed contributor agreement (CLA)

⚠️ We ask all contributors to the Open edX project to submit a signed contributor agreement or indicate their institutional affiliation.
Please see the CONTRIBUTING file for more information.

If you've signed an agreement in the past, you may need to re-sign.
See The New Home of the Open edX Codebase for details.

Once you've signed the CLA, please allow 1 business day for it to be processed.
After this time, you can re-run the CLA check by adding a comment below that you have signed it.
If the CLA check continues to fail, you can tag the @openedx/cla-problems team in a comment for further assistance.

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @Agrendalath. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@OmerBhatti OmerBhatti changed the title chore: Drop py3.8 support | replace pkg_resource with importlib.resources xblock-image-explorer | Drop py3.8 support | replace pkg_resource with importlib.resources Sep 4, 2024
@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Sep 6, 2024
@mphilbrick211
Copy link

Hi @OmerBhatti! Thanks for this contribution!

If you are contributing on behalf of edly, please have your manager reach out to [email protected] to have you added to our existing entity agreement with edly. Thank you!

@farhan
Copy link

farhan commented Sep 10, 2024

@feanil @kdmccormick
Can you guys please merge this as its blocking this PR. Also remove Python 3.8 from settings

@farhan
Copy link

farhan commented Sep 10, 2024

@OmerBhatti Once the Python dependencies PR merges, rebase this PR branch, resolve conflicts if required.

image_explorer/image_explorer.py Outdated Show resolved Hide resolved
@OmerBhatti OmerBhatti force-pushed the omer/replace_pkg_resources branch from 60c3e21 to 18cf504 Compare September 10, 2024 10:40
Copy link
Member

@Agrendalath Agrendalath left a comment

Choose a reason for hiding this comment

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

We're dropping Python 3.8 support here, so we should make the major version bump in image_explorer/__init__.py and indicate in commit messages that this breaking change is incompatible with releases older than Redwood.

@e0d
Copy link

e0d commented Sep 24, 2024

@Agrendalath looks like your comment has been addressed, can you resolve?

@e0d e0d removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Sep 24, 2024
Copy link
Member

@Agrendalath Agrendalath left a comment

Choose a reason for hiding this comment

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

@e0d, I don't see any changes mentioned in #153 (review) in this PR. Am I missing something?

.github/workflows/ci.yml Outdated Show resolved Hide resolved
BREAKING CHANGE: This commit drops support for Python 3.8, requiring Python 3.11 or later. It is incompatible with releases older than Redwood.
Copy link
Member

@Agrendalath Agrendalath left a comment

Choose a reason for hiding this comment

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

👍

  • I tested this: checked that the CI is passing; I didn't test it with Tutor
  • I read through the code
  • I checked for accessibility issues: n/a
  • Includes documentation: n/a

@feanil feanil merged commit 1825348 into openedx:master Oct 25, 2024
8 checks passed
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.

Drop support for Python 3.8
7 participants