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

feat: Application is dockerized #228

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

myhailo-chernyshov-rg
Copy link
Contributor

Description

This PR is addressed to make the converter platform-independent.
To perform it, Dockerfile is written, the files that should not be included into Docker image are specified in .dockerignore.
All base requirements are installed during application installation.

Usage instructions

  1. Build the image:
docker build -t cc2olx .
  1. Run the conversion command in a container by mounting passed argument path directories/files and passing the corresponding arguments to the script:
docker run --rm -v /input/file/path/cc_course_dump.imscc:/data/input/cc_course_dump.imscc -v /output/file/path/output_dir:/data/output/ cc2olx -r zip -i /data/input/cc_course_dump.imscc -o /data/output/edx_dump

It will convert Common Cartridge dump from /input/file/path/cc_course_dump.imscc and save the OLX in /output/file/path/output_dir/edx_dump.zip file.

Deadline

"None"

@openedx-webhooks
Copy link

openedx-webhooks commented Nov 8, 2024

Thanks for the pull request, @myhailo-chernyshov-rg!

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 Nov 8, 2024
@mphilbrick211 mphilbrick211 added needs test run Author's first PR to this repository, awaiting test authorization from Axim and removed needs test run Author's first PR to this repository, awaiting test authorization from Axim labels Dec 4, 2024
@mphilbrick211
Copy link

@ormsbee - are you able to review / merge this?

@@ -41,7 +27,7 @@ def get_version(*file_paths):
],
description=("Command line tool, that converts Common Cartridge " "courses to Open edX Studio imports."),
entry_points={"console_scripts": ["cc2olx=cc2olx.main:main"]},
install_requires=["lxml"],
install_requires=load_requirements("requirements/base.txt"),
Copy link

Choose a reason for hiding this comment

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

Shouldn't this be reading the base.in file and not the pinned base.txt file?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think, using base.in can cause unpredictable behaviour because not tested package versions can be used that can become a reason of conflicts. If we populate constraints.txt, it will be completely ignored and undesirable package versions will be installed. Am I wrong?

utils.py Outdated
Comment on lines 26 to 34
# Skip blank lines, comments, and editable installs
return not (
line == ''
or line.startswith('-r')
or line.startswith('#')
or line.startswith('-e')
or line.startswith('git+')
or line.startswith('-c')
)
Copy link

Choose a reason for hiding this comment

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

startswith can take a tuple as an argument, so you can do:

    return line and not line.startswith(('-r', '#', '-e', 'git+', '-c'))

@myhailo-chernyshov-rg myhailo-chernyshov-rg force-pushed the myhailochernyshov/application-is-dockerized branch from 6e5509e to 80ed18c Compare December 19, 2024 06:45
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: Ready for Review
Development

Successfully merging this pull request may close these issues.

4 participants