exam-scheduler 0.0.3

A commandline tool to create examination schedules

Exam_scheduler

exam_scheduler is a commandline tool to produce teacher-duty schedule in examination for a school/college.

Installation

Install using pip (Recommended)

• Use pip to install, user --user flag

python3 -m pip install --user exam_scheduler

linux and mac users

python3 -m pip install --user exam_scheduler

Don't forget ~/.local/bin should be in your PATH. Add line export PATH=$PATH:"~/.local/bin" in your .bashrc

windows users

for windows users you should have python3 installed in your system

python3 -m pip install --user exam_scheduler

Build from Source

• Clone the repository and checkout to stable commit

git clone https://github.com/srbcheema1/exam_scheduler
cd exam_scheduler
git checkout <latest_version say: v0.0.x>

• install requirements

python3 -m pip install --user -r requirements.txt

• Install exam_scheduler

python3 setup.py install --user

• Building Source Distribution

python3 setup.py sdist

Inputs Required

• room_list - includes room-name and teachers-required as compulsory attributes. Other attributes may follow.

• teachers_list - includes teacher-name and rank as compulsory attributes. Other attributes may follow.

• schedule_list - A 2D matrix includeing relation between a session and a room, value is 'Y' if room is required on particular session.

Config files

• config.json - includes paths for input files in json format. default path ~/.config/exam_scheduler/config.json

{
    "room_list": "/home/srb/programs/exam_scheduler/input/room_list.xlsx",
    "teachers_list": "/home/srb/programs/exam_scheduler/input/teachers_list.xlsx",
    "schedule_list": "/home/srb/programs/exam_scheduler/input/schedule_list.xlsx"
}

By default it will automtically pick excel files from working-directory OR input-folder containing room_list,teachers_list,schedule_list in their names.

• work_ratio.json - includes working ratio for different ranks with respect to rank 1.

{
    "1": 100,
    "2": 150,
    "3": 200,
    "4": 250,
    "5": 300
}

This means if rank 1 will work for 100 units then rank 3 will work 200 units, simply rank 2 will work twice than rank 1.

Usage

srb@srb-pc:$ exam_scheduler --help
usage: exam_scheduler.py [-h] [-v] [-o OUTPUT] [-s SEED] [-r RESERVED]
                         [-vr VR | -vs VS | -vt VT]

optional arguments:
  -h, --help            show this help message and exit
  -v, --version         Display version number
  -o OUTPUT, --output OUTPUT
                        Output file name, default output.xlsx
  -s SEED, --seed SEED  seed value for randomness
  -r RESERVED, --reserved RESERVED
                        reserved number of seats for each session
  -d, --debug           print debug info
  -i, --info            print info in excel
  -vr VR                verify room_list file
  -vs VS                verify schedule_list file
  -vt VT                verify teachers_list file

srb@srb-pc:$ exam_scheduler -o result.xlsx
Using room_list : /home/srb/programs/exam_scheduler/input/room_list.csv
Using teachers_list : /home/srb/programs/exam_scheduler/input/teachers_list.csv
Using schedule_list : /home/srb/programs/exam_scheduler/input/schedule_list.csv
Using seed value : 5
Using reserved value : 0
rank count : {
   "0": 33,
   "1": 7,
   "2": 23,
   "3": 77,
   "4": 59,
   "5": 91
}
average duties : {
   "0": 0.0,
   "1": 2.0,
   "2": 2.347,
   "3": 3.0,
   "4": 3.0,
   "5": 3.0
}
type of rooms : {
   "[1, 3, 5]": 1,
   "[1, 4, 5]": 13,
   "[2, 3, 5]": 1,
   "[2, 4, 5]": 53,
   "[3, 4, 5]": 85,
   "[3, 4]": 25,
   "[3, 5]": 119,
   "[4, 5]": 1
}
Output written to : /home/srb/programs/exam_scheduler/result.xlsx

Contact / Social Media

Developed by

Developer / Author: Srb Cheema

Collaborator : Rakesh Kumar