olxcleaner

library0.3.0pypypiunverified

Tool to scan Open edX courses in OLX format for various errors and inconsistencies. Current version 0.3.0, released Apr 2022. Maintenance mode.

data testing

pip install olxcleaner

github ↗package ↗

INSTALL

IMPORT

SIG · OLXCLEANER

olxcleaner

datapythonv0.3.0

Install

3.8s avg

Import

—

Disk

34MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v0.3.0 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 36.4MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 3.8s · import 0.000s · 37MB

34MB installed

● package 34MB

Code

Verified usage

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

CourseValidator

✓ from olxcleaner.validator import CourseValidator

✗ from olxcleaner.validator import CourseValidator

Validate an Open edX course OLX export for errors.

from olxcleaner import validate from olxcleaner.validator import CourseValidator # Run validation on a course export directory errors = validate('/path/to/course/olx') for error in errors: print(error) # Or use the validator class for more control validator = CourseValidator() validator.load('/path/to/course/olx') result = validator.validate() print(result)

olxcleaner --version

Debug

Known issues

gotchaThe package is designed for Open edX OLX exports, not for general XML. It expects the specific structure of an Open edX course tarball (course.xml, policies, etc.).

fix

Ensure the input is a valid Open edX OLX course directory (e.g., extracted from a .tar.gz export).

affects: all

gotchaThe validate() function prints errors to stderr by default; it does not return a list. To get a list, use CourseValidator explicitly.

fix

Use CourseValidator.validate() which returns a list of Error objects.

affects: all

deprecatedPython 3.6 is the minimum supported version; older Python versions will fail to install.

fix

Upgrade to Python 3.6 or newer.

affects: 0.3.0

Upgrade

Version history

0.3.0latest on PyPI · released Apr 24, 2024

Audit

Dependencies

No dependency data recorded yet.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/openedx/olxcleaner ↗

packagehttps://pypi.org/project/olxcleaner/ ↗