Registry / type-stubs / edx-ccx-keys

edx-ccx-keys

JSON →
library2.0.2pypypiunverified

Opaque key support for Custom Courses on edX (CCX). Provides key classes to identify CCX objects within the edX platform. Current version 2.0.2, release cadence is sporadic.

type-stubs
pip install edx-ccx-keys
github ↗package ↗
INSTALL
IMPORT
SIG · EDX-CCX-KEYS
E
edx-ccx-keys
type-stubspythonv2.0.2
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

CcxLocator
✓ from ccx_keys import CcxLocator
✗ from ccx_keys.locator import CcxLocator

Basic usage of CcxLocator: parsing and creating CCX keys.

from ccx_keys.locator import CcxLocator # Parse a CCX key string key = CcxLocator.from_string('ccx-v1:org+course+ccx@ccx_id') print(key) # Create a new CCX key course_key = CcxLocator('org', 'course', 'run', 'ccx_id') print(course_key)
Debug
Known issues
breakingVersion 2.0.0 dropped support for Python 3.8. Python 3.9+ is required.
fix
Upgrade Python to 3.9+.
affects: >=2.0.0
gotchaCcxLocator.from_string() expects a string in the format 'ccx-v1:org+course+ccx@ccx_id'. Incorrect formats will raise InvalidKeyError.
fix
Ensure the string matches exactly 'ccx-v1:...' or use the constructor directly.
affects: all
Upgrade
Version history
2.0.2latest on PyPI · released Dec 2, 2024
Audit
Dependencies

No dependency data recorded yet.

Agent activity
41 hits · last 30 days
node
36
OpenAI (training)
1
Resources
githubhttps://github.com/openedx/ccx-keys ↗
packagehttps://pypi.org/project/edx-ccx-keys/ ↗