Skip to main content

A django app plugin to add a new API to Open edX to export courses to S3 buckets.

Version Compatibility

For this plugin’s compatibility with Open edX, see the Open edX Release Compatibility table.

Installation

For detailed installation instructions, please refer to the plugin installation guide.

Installation required in:

  • Studio (CMS)

Configuration

1) edx-platform configuration

  • You might need to add the following configuration values to the config file in Open edX. For any release after Juniper, that config file is /edx/etc/cms.yml. If you’re using private.py, add these values to cms/envs/private.py. These should be added to the top level. Ask a fellow developer or devops for these values.

    AWS_ACCESS_KEY_ID: <your aws access id>
    AWS_SECRET_ACCESS_KEY: <your api access key>
    COURSE_IMPORT_EXPORT_BUCKET: <bucket name to export the courses to>
  • For Tutor installations, these values can also be managed through a custom tutor plugin.

How To Use

The API supports a POST API call that accepts the list of course Ids and returns the uploaded paths of the courses on S3

To call the API, Send a POST request to <STUDIO_BASE>/api/courses/v0/export/ with the a payload with a list of course IDs that might look like:

{
   "courses": ["course-v1:edX+DemoX+Demo_Course"]
}

The successful response would look like:

With 200

{
    "successful_uploads": {
        "course-v1:edX+DemoX+Demo_Course": "https://bucket_name.s3.amazonaws.com/course-v1:edX+DemoX+Demo_Course.tar.gz",
        "course-v1:edX+Test+Test_Course": "https://bucket_name.s3.amazonaws.com/course-v1:edX+Test+Test_Course.tar.gz"
    },
    "failed_uploads": {}
}

With 400

{
    "successful_uploads": {
        "course-v1:edX+DemoX+Demo_Course": "https://bucket_name.s3.amazonaws.com/course-v1:edX+DemoX+Demo_Course.tar.gz",
    },
    "failed_uploads": {
        "course-v1:edX+Test+Test_Course": "Error message"
    }
}

The response will contain either the s3 bucket url for successful uploads and/or an error message for failed uploads.

Metadata

Release files for ol-openedx-course-export 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ol-openedx-course-export 0.3.0
File Size Uploaded Provenance Actions
ol_openedx_course_export-0.3.0.tar.gz 6.4 kB Without provenance Details for ol_openedx_course_export-0.3.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ol-openedx-course-export 0.3.0
File Interpreter ABI Platform Actions
ol_openedx_course_export-0.3.0-py3-none-any.whl Python 3 none any Details for ol_openedx_course_export-0.3.0-py3-none-any.whl

Total release size: 16.6 kB

Release files / ol_openedx_course_export-0.3.0.tar.gz

Download URL ol_openedx_course_export-0.3.0.tar.gz
Size 6.4 kB
Tags Source
SHA-256 checksum
How to use checksums
9c39f0d15367522bb3774c49e427a26a41dc1e3a23e64b0c83abe8bb1ee25a37
BLAKE2b-256 checksum
How to use checksums
52d992c21f7bba50ae689ac7ffb8afbff8663d8c643ca44900a0310a0437a544
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release files / ol_openedx_course_export-0.3.0-py3-none-any.whl

Download URL ol_openedx_course_export-0.3.0-py3-none-any.whl
Size 10.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6e409165b65449872dd10c73f561d2e7d554c55338d8ba41e4e685d9e79e7a07
BLAKE2b-256 checksum
How to use checksums
d30c60eb85edfd4c3a4cd803d7878a7fbaff66389291376b809ec9301d78caf9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Security for ol-openedx-course-export 0.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page