edx-ccx-keys

What it is and what it does

edx-ccx-keys is a specialized library for the edX platform that defines opaque key types for Custom Courses for EdX (CCX). It builds on edx-opaque-keys to provide course identifiers and locators specific to CCX, abstracting the internal representation so that course references remain stable even if the underlying storage format changes.

The package is part of the broader edX codebase and is intended for developers working within or extending the edX platform. It has minimal dependencies (edx-opaque-keys and six) and is marked production-stable, making it suitable for production edX deployments that need to work with custom course instances.

Use it for:

• Building edX plugins or extensions that need to reference or create custom course instances
• Integrating with edX platform APIs that require opaque course keys for custom courses
• Maintaining stable course identifiers across edX CCX workflows

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Provides opaque key implementations for Custom Courses for EdX (CCX), enabling secure, abstracted course identifiers within the edX platform.

Yes, if you are developing for or extending the edX platform and need to work with custom courses. The package is actively maintained, has no known vulnerabilities, and low install friction. AGPL licensing is a constraint for proprietary use. Outside the edX ecosystem, this package has no utility.

Install

edx-ccx-keys on PyPI

pip install edx-ccx-keys

uv add edx-ccx-keys

poetry add edx-ccx-keys

Installing edx-ccx-keys

Before you install

Low install friction with a pure-Python wheel. Actively maintained as of 2026-05-30 with production-stable status, though last release was 620 days ago.

License in practice

Licensed under AGPL, which requires derivative works and modifications to be released under the same license. Suitable for open-source projects but restrictive for proprietary software.

Quickstart

pip install edx-ccx-keys

from edx_ccx_keys.locator import CCXLocator
key = CCXLocator.from_course_locator(course_locator)

Verify before relying

• What specific opaque key operations (serialization, validation, parsing) are supported
• Whether CCXLocator is the primary public API or if other entry points exist
• How this package is typically integrated into edX deployments

Package facts

Evidence: edx_ccx_keys-2.0.2-py3-none-any.whl

Tags

More Application Frameworks packages