About

courses feature

Provides

Models
CategoryCoursePagePageAttachmentPageRevision
Services
CoursesService
Routes
//<COURSES_PATH>/<COURSES_PATH>/<course_slug>/<COURSES_PATH>/<course_slug>/<COURSES_CATEGORY_SEGMENT>/<category_slug>/<COURSES_PATH>/<course_slug>/<COURSES_PAGE_SEGMENT>/<page_slug>/<COURSES_PATH>/search/admin/courses/admin/courses/<int:course_id>/categories/new/admin/courses/<int:course_id>/copy/admin/courses/<int:course_id>/delete/admin/courses/<int:course_id>/edit/admin/courses/<int:course_id>/pages/new/admin/courses/activity/admin/courses/attachments/<int:attachment_id>/detach/admin/courses/categories/<int:category_id>/delete/admin/courses/categories/<int:category_id>/edit/admin/courses/files/admin/courses/new/admin/courses/pages/admin/courses/pages/<int:page_id>/attach/admin/courses/pages/<int:page_id>/delete/admin/courses/pages/<int:page_id>/edit/admin/courses/pages/<int:page_id>/history/admin/courses/pages/<int:page_id>/history/<int:revision_id>/admin/courses/pages/<int:page_id>/history/<int:revision_id>/restore/admin/courses/pages/new/admin/courses/preview
Hooks filled
admin.bar.contextlayout.authenticated_sidebarlayout.head.csslayout.scripts
Translations
es

Commands

  • $ splent feature:courses copy-course YEAR [OPTIONS]

    Duplicate a course into a new year, everything withheld.

  • $ splent feature:courses hide REFERENCE [OPTIONS]

    Withhold something from students right now.

  • $ splent feature:courses import-bookstack [OPTIONS]

    Copy a BookStack wiki into this product's courses.

  • $ splent feature:courses new-course YEAR [OPTIONS]

    Start an academic year, hidden.

  • $ splent feature:courses publish REFERENCE [OPTIONS]

    Make something visible to students right now.

  • $ splent feature:courses repair-links [OPTIONS]

    Point migrated bodies at the files that came with them.

  • $ splent feature:courses status [COURSE_REF]

    What a student sees right now, and what is scheduled.

  • $ splent feature:courses verify-bookstack [OPTIONS]

    Check an import against the wiki it came from.

Run them in your workspace once the feature is installed in the selected product.

Configuration

Setting Default What it does
COURSES_PATH cursos The words the material is served under. Spanish by default because that is what the products of this line are taught in, and a URL is read by students far more often than it is typed by staff.
COURSES_CATEGORY_SEGMENT categoria No description yet.
COURSES_PAGE_SEGMENT pagina No description yet.
COURSES_NAME_PREFIX empty How a new academic year is named and described. Empty here because only a product knows what its subject is called.
COURSES_DESCRIPTION_TEMPLATE empty No description yet.
COURSES_DEFAULT_CATEGORIES empty No description yet.
COURSES_TIMEZONE Europe/Madrid The zone staff type release dates in. Getting this wrong publishes material an hour early twice a year.

These are the defaults. A product changes them in its own pyproject.toml, under [tool.splent.config], or in .env.deploy in production.

Dependencies

Works better with

Collisions

In product lines

Extension points

Templates
courses/admin/activity.htmlcourses/admin/category_form.htmlcourses/admin/course_form.htmlcourses/admin/courses.htmlcourses/admin/files.htmlcourses/admin/page_form.htmlcourses/admin/page_history.htmlcourses/admin/page_revision.htmlcourses/admin/pages.htmlcourses/category.htmlcourses/course.htmlcourses/hooks/admin_sidebar.htmlcourses/index.htmlcourses/page.html
Services
CoursesService
Models
CategoryCoursePagePageAttachmentPageRevision
Routes
A refinement can add routes to its blueprint

Other features fill its hook slots. A refinement can override its templates and services or extend its models without forking it.

Compatibility

Python
>=3.13
SPLENT framework
>=1.30.0
Python packages
markdown-it-py[linkify]>=3.0mdit-py-plugins>=0.4nh3>=0.2markdownify>=0.13