Skip to main content

Documentation Status

sedrila: Tool infrastructure for building and running "self-driven lab" courses

A "self-driven lab" (SeDriLa) course is one where students select freely a subset from a large set of tasks. The tasks are described with sufficient detail that no guidance from an instructor is needed most of the time.

sedrila is a command-line tool supporting course authors for authoring a course and then course instructors and students for executing it.

Find the documentation at readthedocs.

1. Ideas for future versions

1.1 A currently needed refactoring: Target directory structure

The current layout of the source tree is wrong. Currently, the templates and baseresources directories will end up as top-level directories when the package is installed, which means they will clash with any top-level modules of that name anywhere in our dependencies.

We need to perform the following refactorings to arrive at a proper structure:

  • py --> sedrila: This will be the top level directory that gets installed.
  • sedrila/sdrl/* --> sedrila/*: We remove the now-intermediate namespace. This implies joining the current sdrl/tests into sedrila/tests.
  • templates --> sedrila/templates: The HTML templates simply become part of the tree to be installed.
  • baseresources --> sedrila/baseresources: Ditto.

These changes require a lot of changes of import statements. For instance, the current module base will become sedrila.base and sdrl.course will become sedrila.course. The logic for computing sedrila_libdir in courses.py must be adapted. SedrilaArgParser.get_version() must be adapted. The files lists in pyproject.toml must be corrected.

Also: Perhaps use deply for checking the layer structure described in internal_notes.md: https://github.com/vashkatsi/deply

1.2 instructor

  • Reject submissions where course_url is different from what it was in that repo's first accepted submission.

1.3 student

  • ...

2. Development process: TODO-handling during development

We use this convention for the development of sedrila. It may also be helpful for course authors if the team is small enough.

If something is incomplete, add a TODO marker with a priorization digit and add a short description of what needs to be done. Examples:

  • TODO 1: find proper formulation
  • TODO 2: restructure to use ACME lib
  • TODO 3: add automatic grammar correction

Priorities:

  • 1: to be completed soon (within a few days)
  • 2: to be completed once the prio 1 things are done (within days or a few weeks)
  • 3: to be completed at some later time (usually several weeks or more into the future, because it is big) or never (because it is not-so-important: "nice-to-have features")

Then use the IDE global search to work through these layer-by-layer. Demote items to a lower priority when they become stale or remove them. Kick out prio 3 items when they become unlikely.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sedrila-3.2.0.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sedrila-3.2.0-py3-none-any.whl (158.9 kB view details)

Uploaded Python 3

File details

Details for the file sedrila-3.2.0.tar.gz.

File metadata

  • Download URL: sedrila-3.2.0.tar.gz
  • Upload date:
  • Size: 1.1 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.13.5 Linux/6.18.33.2-microsoft-standard-WSL2

File hashes

Hashes for sedrila-3.2.0.tar.gz
Algorithm Hash digest
SHA256 74e8417ed43b01c73e6b5fe334b76030a04ae412b2c7ed0481c622f037d2eb61
MD5 7b95ace20bb64b743b984625f03d06b9
BLAKE2b-256 b9e4bd23f3516a3399b30b4d6ad45e97817ffd875a626ecbcbba00e5327d7150

See more details on using hashes here.

File details

Details for the file sedrila-3.2.0-py3-none-any.whl.

File metadata

  • Download URL: sedrila-3.2.0-py3-none-any.whl
  • Upload date:
  • Size: 158.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.13.5 Linux/6.18.33.2-microsoft-standard-WSL2

File hashes

Hashes for sedrila-3.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9bed460b2692a30fca46b501eea150667663d2ad9531c637bd3f349f86a8c76d
MD5 c9604e7c2bbadf8b6fa2970483d17803
BLAKE2b-256 95e8143697c92f11ec11d75da3dd61155dacb4cca07ab83b2dfed471275cf3ad

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

3.2.0 This release

2 files

3.1.2

2 files

3.1.1

2 files

3.1.0

2 files

3.0.0

2 files

2.11.1

2 files

2.11.0

2 files

2.10.2

2 files

2.10.1

2 files

2.10.0

2 files

2.9.0

2 files

2.8.1

2 files

2.8.0

2 files

2.7.0

2 files

2.6.4

2 files

2.6.3

2 files

2.6.2

2 files

2.6.1

2 files

2.6.0

2 files

2.4.0

2 files

2.3.0

2 files

2.2.1

2 files

2.2.0

2 files

2.1.2

2 files

2.1.1

2 files

2.1.0

2 files

2.0.0

2 files

1.3.2

2 files

1.3.1

2 files

1.3.0

2 files

1.2.1

2 files

1.2.0

2 files

1.1.0

2 files

1.0.0

2 files

0.7.0

2 files

0.6.0

2 files

0.5.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page