Update README.md

README.md

@@ -2,60 +2,52 @@
 
 ib-clearance is a program which helps schools manage the entrance and exiting of their IB students. Due to the unique nature of IB students' timetables, the program helps check individual timetables and give clearance to students who have finished for the day.
 
-### Building
+## Building
 
 The code is currently designed to run on Python 3.6.*.
 
 I recommend building executables with `pyinstaller` with `pyinstaller --onefile ib-clearance.py`.
 
-### Lesson IDs
+## Database specification
 
-Equivalents of lesson names for use in class databases.
+The program requires sqlite databases for each class.
 
-- Academic Writing
+Each database must contain:
-    - 'aw'
+
-- Biology
+| Table       | Description                                                |
-    - 'bi'
+| ----------- | ---------------------------------------------------------- |
-- Business Management
+| `students`  | Contains students' names, ID numbers and class preferences |
-    - 'bm'
+| `timetable` | Timetable information for class                            |
-- Chemistry
+
-    - 'ch'
+### `students`
-- Computer Science
+
-    - 'cs'
+| Column | Data type | Description                       |
-- Economics
+| ------ | --------- | --------------------------------- |
-    - 'ec'
+| `id`   | `INTEGER` | Student ID number used in program |
-- English A
+| `g1`   | `TEXT`    | Group 1 subject ID                |
-    - 'ena'
+| `g2`   | `TEXT`    | Group 2 subject ID                |
-- English B
+| `g3`   | `TEXT`    | Group 3 subject ID                |
-    - 'enb'
+| `g4`   | `TEXT`    | Group 4 subject ID                |
-- French
+| `g5`   | `TEXT`    | Group 5 subject ID                |
-    - 'fr'
+| `g6`   | `TEXT`    | Group 6 subject ID                |
-- Geography
+| `name` | `TEXT`    | Full name of student              |
-    - 'ge'
+
-- German
+### `timetable`
-    - 'de'
+
-- Guidance
+| Column      | Data type | Description                                   |
-    - 'gu'
+| ----------- | --------- | --------------------------------------------- |
-- Mathematical Studies
+| `day`       | `TEXT`    | Day of the week (e.g. `monday`)               |
-    - 'mst'
+| `end_time`  | `TEXT`    | Ending time of lesson (e.g. `09:55`, `13:05`) |
-- Mathematics HL
+| `lesson_id` | `TEXT`    | Subject ID of the lesson (e.g. `ena`)         |
-    - 'mhl'
+
-- Mathematics SL
+#### Subject IDs
-    - 'msl'
+
-- Polish A
+Subject IDs may be anything, as long as consistency is maintained throughout the tables. There are two hard-coded IDs that are always taken by every student:
-    - 'pl'
+
-- Psychology
+| Subject             | ID    |
-    - 'ps'
+| ------------------- | ----- |
-- Self-Taught Language A
+| Theory of Knowledge | `tok` |
-    - 'st'
+| Guidance            | `gu`  |
-- Spanish
-    - 'es'
-- Theory of Knowledge
-    - 'tok'
-- Turkish A
-    - 'tr'
-- Visual Arts
-    - 'va'
 
 ## License
 

ib-clearance.py

@@ -72,7 +72,7 @@ def select_final_time(conn, day, id):
                 OR g5 = lesson_id
                 OR g6 = lesson_id
                 OR lesson_id = 'gu'
-                OR lesson_id = 'to'
+                OR lesson_id = 'tok'
         WHERE id = ? AND day = ?
         ORDER BY end_time DESC
         LIMIT 1