course_assigner
Overview
course_assigner is a Python library for assigning students to courses based on a preference list. The documentation below should help you understand the parameters passed to the course_assigner functions and what they return, but I recommend starting with examples. Check out the examples in the samples folder
Installation instructions
python3 -m pip install --upgrade pip
python3 -m pip install course_assigner
Classes
The course_assigner library has one method:
assign: assigns
assign
import course_assigner.assign
from course_assigner import assign
request syntax
assigned_courses = assign(
courses = {
course1: {
"min": course 1 min,
"max": course 1 max
},
course2: {
"min": course 2 min,
"max": course 2 max
},
...
courseN: {
"min": course N min,
"max": course N max
}
},
preferences = {
student_key1: [
student 1 most wanted course,
student 1 second most wanted course,
...
student 1 least wanted course
],
student_key2: [
student 2 most wanted course,
student 2 second most wanted course,
...
student 2 least wanted course
],
...
student_keyN: [
student N most wanted course,
student N second most wanted course,
...
student N least wanted course
],
}
)
parameters
courses(dict): A dictionary which shows all of the courses which the student can sign up for. The key in each pair is the name of the course. The value has an additional dictionairy with keys "min" and "max". The value for key "min" is the minimum number of people that can sign up for the course, and the value for key "max" is the maximum number of people that can sign up for the course. If there are no minimums or maximums, the value of "min" should be 0 and the value of "max" should be the total number of students.preferences(dict): A dictionary value which lists the preferences for each student. The key in each pair is the name or identifier for the student. The value is a list of student preferences in which the entry at index 0 is the most preferred course and the entry at index n-1 (for a list of length n) is the least preferred course.
response syntax
{
"student_key1":student 1 assigned course,
"student_key2":student 2 assigned course,
...
"student_keyN":student N assigned course
}
Metadata
Release files for course-assigner 0.0.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| course_assigner-0.0.2.tar.gz | 3.0 kB | Without provenance | Details for course_assigner-0.0.2.tar.gz |
Release files / course_assigner-0.0.2.tar.gz
| Download URL | course_assigner-0.0.2.tar.gz |
|---|---|
| Size | 3.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
95d415c70b563193c9ae968b52c6102f110e70789e771fe7f819fd430fdbdfa2
|
|
BLAKE2b-256 checksum How to use checksums |
e2d05b47475c0004fdb19a498fdec31d64f47c64d7377236d3e0c689c5731f1f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.10.11
|
Security for course-assigner 0.0.2
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.