Skip to main content

Course Export S3 Plugin

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>
  • Optionally route S3 export tasks to their own Celery queue. Exports take a while, so on the default queue they hold up other Studio tasks. Unset, exports use edx-platform’s default routing. A worker must consume the queue, or exports wait there indefinitely.

    COURSE_EXPORT_CELERY_QUEUE: "edx.cms.core.course_export"
  • 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.

Content versions

A course’s published version only moves when modulestore content is published. Files uploaded to the course and transcripts uploaded through VAL never move it, though an export carries both. To tell whether an earlier export has gone stale, send a POST request to <STUDIO_BASE>/api/courses/v0/export/versions/ with up to 200 course ids:

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

The response reports each course’s published version, how many files it has and which was uploaded last, and how many VAL transcripts its videos have and when any last changed. Ids that name no course on the instance are listed under missing instead of failing the request. Every value is read from an index or an aggregate, never by walking the course, so it is cheap enough to poll for every course on an instance.

A course’s videos are the ones its published video blocks name in edx_video_id, which is how an export finds their transcripts. They are read from the published structure once per published version and cached for a week. A video that only an unpublished block names is not counted until the block is published. VAL’s own course-to-video link is not used, because a video created by uploading a transcript in the Studio video editor is linked to no course.

{
    "versions": {
        "course-v1:edX+DemoX+Demo_Course": {
            "published_version": "<ObjectId of the published branch>",
            "static_assets": {
                "count": 12,
                "latest_upload": "2026-09-01T14:03:22+00:00",
                "latest_asset": "asset-v1:edX+DemoX+Demo_Course+type@asset+block@syllabus.pdf"
            },
            "transcripts": {
                "count": 40,
                "latest_modified": "2026-09-12T09:30:00.123456+00:00"
            }
        }
    },
    "missing": ["course-v1:edX+Gone+Run"]
}

Like the export API, it requires JWT authentication as a staff user.

Metadata

Release files for ol-openedx-course-export 0.5.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.5.0
File Size Uploaded Provenance Actions
ol_openedx_course_export-0.5.0.tar.gz 11.9 kB Without provenance Details for ol_openedx_course_export-0.5.0.tar.gz

Built distribution (wheel)

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

Total release size: 29.2 kB

Release files / ol_openedx_course_export-0.5.0.tar.gz

Download URL ol_openedx_course_export-0.5.0.tar.gz
Size 11.9 kB
Tags Source
SHA-256 checksum
How to use checksums
b0852ce9062739d4b0b37b752b529ecb6ca16a21702753f246a9d76c8c89909c
BLAKE2b-256 checksum
How to use checksums
399ecee1083af3743c97bff85c10fb04b186206f334e88027f06307878c23d7d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

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

Download URL ol_openedx_course_export-0.5.0-py3-none-any.whl
Size 17.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
92bed13f774d1c57f7603c6f6d2b07ad21fea0c3e7c4144bd1c73ee12910e591
BLAKE2b-256 checksum
How to use checksums
3e7c4f9100a444ffda64a3bf617711446cc73c75d4edcd1872680f5ee7e476a2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.15.2

Security for ol-openedx-course-export 0.5.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