# Wagtail LMS
A Learning Management System extension for Wagtail CMS with SCORM 1.2/2004 support.
## ⚠️ Alpha Release
**This package is in early development (v0.1.0-alpha).**
**Currently tested on:**
- Python 3.13.0
- Django 5.2.3
- Wagtail 7.0.1
Other versions may work but are untested. See the [Roadmap](https://github.com/dr-rompecabezas/wagtail-lms/docs/roadmap.md) for planned improvements including broader version support and CI/CD integration.
## Features
- 📚 **Course Management** - Integrate courses into Wagtail's page system
- 📦 **SCORM Support** - Full SCORM 1.2 and 2004 package compatibility
- 👥 **Enrollment Tracking** - Automatic student enrollment and progress monitoring
- 📊 **SCORM API** - Complete runtime API implementation for content interactivity
- 🔒 **Secure Delivery** - Path-validated content serving with iframe support
- 💾 **Progress Persistence** - CMI data model storage with suspend/resume capability
- 🔄 **Concurrency Handling** - Retry logic for SQLite database lock scenarios
## Development Status
✅ **Core functionality tested and working**
- Comprehensive test suite with **86% code coverage**
- 65+ tests covering models, views, API, and integration workflows
- Example project fully functional for development and testing
- Database lock handling for concurrent SCORM operations
- Wagtail preview mode fully supported
See `example_project/README.md` for setup instructions.
## Installation
```bash
pip install wagtail-lms
```
## Quick Start
1. Add to `INSTALLED_APPS` in your Django settings:
```python
INSTALLED_APPS = [
# ...
'wagtail_lms',
# ...
]
```
2. Add wagtail-lms URLs to your `urls.py`:
```python
from django.urls import path, include
urlpatterns = [
# ...
path('lms/', include('wagtail_lms.urls')),
# ...
]
```
3. Run migrations:
```bash
python manage.py migrate wagtail_lms
```
4. Collect static files:
```bash
python manage.py collectstatic
```
## Configuration
Optional settings in your Django settings:
```python
# SCORM package upload directory
WAGTAIL_LMS_SCORM_UPLOAD_PATH = 'scorm_packages/'
# Extracted SCORM content directory
WAGTAIL_LMS_CONTENT_PATH = 'scorm_content/'
# Auto-enroll users when they visit a course
WAGTAIL_LMS_AUTO_ENROLL = False
```
## Usage
### Creating a Course
1. Log into Wagtail admin
2. Create a new "Course Page" under Pages
3. Upload a SCORM package via Django Admin → SCORM Packages
4. Assign the SCORM package to your course page
### SCORM Package Requirements
- Must be a valid SCORM 1.2 or 2004 ZIP file
- Must contain `imsmanifest.xml` at the root
- Launch file must be specified in the manifest
## Development
### Running Tests
The project includes a comprehensive test suite with 86% code coverage.
```bash
# Install testing dependencies (pytest, pytest-django, pytest-cov)
uv sync --extra testing
# Run all tests
PYTHONPATH=. uv run pytest
# Run with coverage report
PYTHONPATH=. uv run pytest --cov=src/wagtail_lms --cov-report=term-missing
# Run specific test file
PYTHONPATH=. uv run pytest tests/test_models.py -v
```
### Database Considerations
**SQLite**: The package includes retry logic with exponential backoff to handle database lock errors during concurrent SCORM API operations. For development with the example project:
```python
# example_project/settings.py
DATABASES = {
"default": {
"ENGINE": "django.db.backends.sqlite3",
"NAME": "db.sqlite3",
"OPTIONS": {
"timeout": 20, # Increased timeout for SCORM operations
},
}
}
```
**Production**: For production deployments, PostgreSQL is recommended for better concurrency handling:
```python
DATABASES = {
"default": {
"ENGINE": "django.db.backends.postgresql",
"NAME": "wagtail_lms",
# ... other PostgreSQL settings
}
}
```
## Acknowledgments
- Built with [Django](https://djangoproject.com/) and [Wagtail CMS](https://wagtail.org/)
- SCORM implementation based on ADL specifications
- Inspired by open-source LMS solutions like [Moodle](https://moodle.org/) and [Open edX](https://openedx.org/)
## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/dr-rompecabezas/LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "wagtail-lms",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.13",
"maintainer_email": null,
"keywords": "wagtail, django, lms, scorm, xAPI, e-learning, education",
"author": "Felipe Villegas",
"author_email": "Felipe Villegas <felavid@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/64/c2/e844a0027afacf5335c0489b4c2fca4d546a8bc83ad0fd9c6ad447df183a/wagtail_lms-0.1.0.tar.gz",
"platform": null,
"description": "# Wagtail LMS\n\nA Learning Management System extension for Wagtail CMS with SCORM 1.2/2004 support.\n\n## \u26a0\ufe0f Alpha Release\n\n**This package is in early development (v0.1.0-alpha).**\n\n**Currently tested on:**\n\n- Python 3.13.0\n- Django 5.2.3\n- Wagtail 7.0.1\n\nOther versions may work but are untested. See the [Roadmap](https://github.com/dr-rompecabezas/wagtail-lms/docs/roadmap.md) for planned improvements including broader version support and CI/CD integration.\n\n## Features\n\n- \ud83d\udcda **Course Management** - Integrate courses into Wagtail's page system\n- \ud83d\udce6 **SCORM Support** - Full SCORM 1.2 and 2004 package compatibility\n- \ud83d\udc65 **Enrollment Tracking** - Automatic student enrollment and progress monitoring\n- \ud83d\udcca **SCORM API** - Complete runtime API implementation for content interactivity\n- \ud83d\udd12 **Secure Delivery** - Path-validated content serving with iframe support\n- \ud83d\udcbe **Progress Persistence** - CMI data model storage with suspend/resume capability\n- \ud83d\udd04 **Concurrency Handling** - Retry logic for SQLite database lock scenarios\n\n## Development Status\n\n\u2705 **Core functionality tested and working**\n\n- Comprehensive test suite with **86% code coverage**\n- 65+ tests covering models, views, API, and integration workflows\n- Example project fully functional for development and testing\n- Database lock handling for concurrent SCORM operations\n- Wagtail preview mode fully supported\n\nSee `example_project/README.md` for setup instructions.\n\n## Installation\n\n```bash\npip install wagtail-lms\n```\n\n## Quick Start\n\n1. Add to `INSTALLED_APPS` in your Django settings:\n\n ```python\n INSTALLED_APPS = [\n # ...\n 'wagtail_lms',\n # ...\n ]\n ```\n\n2. Add wagtail-lms URLs to your `urls.py`:\n\n ```python\n from django.urls import path, include\n\n urlpatterns = [\n # ...\n path('lms/', include('wagtail_lms.urls')),\n # ...\n ]\n ```\n\n3. Run migrations:\n\n ```bash\n python manage.py migrate wagtail_lms\n ```\n\n4. Collect static files:\n\n ```bash\n python manage.py collectstatic\n ```\n\n## Configuration\n\nOptional settings in your Django settings:\n\n```python\n# SCORM package upload directory\nWAGTAIL_LMS_SCORM_UPLOAD_PATH = 'scorm_packages/'\n\n# Extracted SCORM content directory\nWAGTAIL_LMS_CONTENT_PATH = 'scorm_content/'\n\n# Auto-enroll users when they visit a course\nWAGTAIL_LMS_AUTO_ENROLL = False\n```\n\n## Usage\n\n### Creating a Course\n\n1. Log into Wagtail admin\n2. Create a new \"Course Page\" under Pages\n3. Upload a SCORM package via Django Admin \u2192 SCORM Packages\n4. Assign the SCORM package to your course page\n\n### SCORM Package Requirements\n\n- Must be a valid SCORM 1.2 or 2004 ZIP file\n- Must contain `imsmanifest.xml` at the root\n- Launch file must be specified in the manifest\n\n## Development\n\n### Running Tests\n\nThe project includes a comprehensive test suite with 86% code coverage.\n\n```bash\n# Install testing dependencies (pytest, pytest-django, pytest-cov)\nuv sync --extra testing\n\n# Run all tests\nPYTHONPATH=. uv run pytest\n\n# Run with coverage report\nPYTHONPATH=. uv run pytest --cov=src/wagtail_lms --cov-report=term-missing\n\n# Run specific test file\nPYTHONPATH=. uv run pytest tests/test_models.py -v\n```\n\n### Database Considerations\n\n**SQLite**: The package includes retry logic with exponential backoff to handle database lock errors during concurrent SCORM API operations. For development with the example project:\n\n```python\n# example_project/settings.py\nDATABASES = {\n \"default\": {\n \"ENGINE\": \"django.db.backends.sqlite3\",\n \"NAME\": \"db.sqlite3\",\n \"OPTIONS\": {\n \"timeout\": 20, # Increased timeout for SCORM operations\n },\n }\n}\n```\n\n**Production**: For production deployments, PostgreSQL is recommended for better concurrency handling:\n\n```python\nDATABASES = {\n \"default\": {\n \"ENGINE\": \"django.db.backends.postgresql\",\n \"NAME\": \"wagtail_lms\",\n # ... other PostgreSQL settings\n }\n}\n```\n\n## Acknowledgments\n\n- Built with [Django](https://djangoproject.com/) and [Wagtail CMS](https://wagtail.org/)\n- SCORM implementation based on ADL specifications\n- Inspired by open-source LMS solutions like [Moodle](https://moodle.org/) and [Open edX](https://openedx.org/)\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](https://github.com/dr-rompecabezas/LICENSE) file for details.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A Learning Management System extension for Wagtail with SCORM and xAPI support",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/dr-rompecabezas/wagtail-lms/issues",
"Changelog": "https://github.com/dr-rompecabezas/wagtail-lms/blob/main/CHANGELOG.md",
"Documentation": "https://wagtail-lms.readthedocs.io",
"Homepage": "https://github.com/dr-rompecabezas/wagtail-lms",
"Repository": "https://github.com/dr-rompecabezas/wagtail-lms"
},
"split_keywords": [
"wagtail",
" django",
" lms",
" scorm",
" xapi",
" e-learning",
" education"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "79063974d348b0dc95523d88ccebffd5f82b34a77dd5142480519ba6dcc5e7d9",
"md5": "93b762dfee1740aa0e8e885923280177",
"sha256": "6b7b4c435dc11d2d39c9670c94d9b33884ddc61bf226418390a0dae45aa7ee01"
},
"downloads": -1,
"filename": "wagtail_lms-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "93b762dfee1740aa0e8e885923280177",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.13",
"size": 19098,
"upload_time": "2025-10-27T00:11:03",
"upload_time_iso_8601": "2025-10-27T00:11:03.971016Z",
"url": "https://files.pythonhosted.org/packages/79/06/3974d348b0dc95523d88ccebffd5f82b34a77dd5142480519ba6dcc5e7d9/wagtail_lms-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "64c2e844a0027afacf5335c0489b4c2fca4d546a8bc83ad0fd9c6ad447df183a",
"md5": "70a300842d5444c7087394d3d31c76d8",
"sha256": "292a0f003f2f70f6073667affb9d7d386d9efbc3cf9be13c00f4b1cb45ccb224"
},
"downloads": -1,
"filename": "wagtail_lms-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "70a300842d5444c7087394d3d31c76d8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.13",
"size": 13875,
"upload_time": "2025-10-27T00:11:05",
"upload_time_iso_8601": "2025-10-27T00:11:05.400828Z",
"url": "https://files.pythonhosted.org/packages/64/c2/e844a0027afacf5335c0489b4c2fca4d546a8bc83ad0fd9c6ad447df183a/wagtail_lms-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-27 00:11:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dr-rompecabezas",
"github_project": "wagtail-lms",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "wagtail-lms"
}
JSON
