From 8932fd7ac67e0cbd5885a1c0ae6492fb7b0853a7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Abdulkadir=20Furkan=20=C5=9Eanl=C4=B1?= Date: Sat, 3 Nov 2018 10:07:26 +0100 Subject: [PATCH] Add documentation and rename main file --- .gitignore | 3 +++ README.md | 53 +++++++++++++++++++++++++++++++++++++++- IA.py => ib-clearance.py | 0 3 files changed, 55 insertions(+), 1 deletion(-) rename IA.py => ib-clearance.py (100%) diff --git a/.gitignore b/.gitignore index 6f7a6d9..8068375 100644 --- a/.gitignore +++ b/.gitignore @@ -109,3 +109,6 @@ venv.bak/ .mypy_cache/ .dmypy.json dmypy.json + +# database files (may contain sensitive student info) +*.db diff --git a/README.md b/README.md index 2478a2c..ba38f84 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,62 @@ # ib-clearance -_Insert description here_ +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 +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 +Equivalents of lesson names for use in class databases. + +- Academic Writing + - 'aw' +- Biology + - 'bi' +- Business Management + - 'bm' +- Chemistry + - 'ch' +- Computer Science + - 'cs' +- Economics + - 'ec' +- English A + - 'ena' +- English B + - 'enb' +- French + - 'fr' +- Geography + - 'ge' +- German + - 'de' +- Guidance + - 'gu' +- Mathematical Studies + - 'mst' +- Mathematics HL + - 'mhl' +- Mathematics SL + - 'msl' +- Polish A + - 'pl' +- Psychology + - 'ps' +- Self-Taught Language A + - 'st' +- Spanish + - 'es' +- Theory of Knowledge + - 'tok' +- Turkish A + - 'tr' +- Visual Arts + - 'va' + ## License Copyright (C) 2018 Abdulkadir Furkan Şanlı diff --git a/IA.py b/ib-clearance.py similarity index 100% rename from IA.py rename to ib-clearance.py