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

Remove obsolete, broken pyandoc usage #27

Merged
merged 2 commits into from
Sep 27, 2024
Merged

Conversation

jikamens
Copy link

Pyandoc is no longer supported, and the final version of it on PyPI is incompatible with how our setup.py was using it. This commit removes pyandoc entirely and lets Python's setuptools handle the README conversion from Markdown as needed.

@openedx-webhooks
Copy link

openedx-webhooks commented Sep 25, 2024

Thanks for the pull request, @jikamens!

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

🔘 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 unmaintained.

To get help with finding a technical reviewer, tag the community contributions project manager for this PR in a comment and let them know that your changes are ready for review:

  1. On the right-hand side of the PR, find the Contributions project, click the caret in the top right corner to expand it, and check the "Primary PM" field for the name of your PM.
  2. Find their GitHub handle here.

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 25, 2024
Pyandoc is no longer supported, and the final version of it on PyPI is
incompatible with how our setup.py was using it. This commit removes
pyandoc entirely and lets Python's setuptools handle the README
conversion from Markdown as needed.
Copy link

@feanil feanil left a comment

Choose a reason for hiding this comment

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

Generally looks good and is probably good to merge and release once the version is bumped and the CLA is signed.

setup.py Outdated
@@ -63,15 +49,15 @@ def is_requirement(line):
version='0.2.1',
Copy link

Choose a reason for hiding this comment

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

This generally looks good. @jikamens can you bump this version as well so we can do a new release?

@e0d
Copy link

e0d commented Sep 26, 2024

@jikamens I was curious if you are using the Open edX platform or just our fork of MongoDBProxy?

@e0d e0d changed the title Remove obsolete, broken pyandoc usage Remove obsolete, broken pyandoc usage Sep 26, 2024
@e0d e0d changed the title Remove obsolete, broken pyandoc usage Remove obsolete, broken pyandoc usage Sep 26, 2024
@e0d
Copy link

e0d commented Sep 26, 2024

@openedx/cla-checker

@e0d e0d changed the title Remove obsolete, broken pyandoc usage Remove obsolete, broken pyandoc usage Sep 26, 2024
@jikamens
Copy link
Author

@jikamens I was curious if you are using the Open edX platform or just our fork of MongoDBProxy?

Just using MongoDBProxy.

@feanil feanil merged commit 77fc125 into openedx:master Sep 27, 2024
3 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
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants